Skip to content

Improve and extend the _read() method availability for its users and related methods. Part 1: Cupsprinter and on/offline. #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
belono wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve and extend the _read() method availability for its users and related methods. Part 1: Cupsprinter and on/offline. #709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e593995
Improve on/offline masks consistency and its usage by the Cups connector
belono Oct 2, 2025
3b32f8b
Fix sorting
belono Oct 2, 2025
0b00174
Add test for the _read() method on the cups printer
belono Oct 19, 2025
3a6d645
Add missing function return value annotation
belono Oct 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/escpos/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,8 @@
RT_STATUS: bytes = DLE + EOT
RT_STATUS_ONLINE: bytes = RT_STATUS + b"\x01"
RT_STATUS_PAPER: bytes = RT_STATUS + b"\x04"
RT_MASK_ONLINE: int = 8
RT_MASK_ONLINE: int = 18
RT_MASK_OFFLINE: int = 26
RT_MASK_PAPER: int = 18
RT_MASK_LOWPAPER: int = 30
RT_MASK_NOPAPER: int = 114
4 changes: 2 additions & 2 deletions src/escpos/escpos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
QR_MODEL_2,
RT_MASK_LOWPAPER,
RT_MASK_NOPAPER,
RT_MASK_ONLINE,
RT_MASK_OFFLINE,
RT_MASK_PAPER,
RT_STATUS_ONLINE,
RT_STATUS_PAPER,
Expand Down Expand Up @@ -1442,7 +1442,7 @@ def is_online(self) -> bool:
status = self.query_status(RT_STATUS_ONLINE)
if len(status) == 0:
return False
return not (status[0] & RT_MASK_ONLINE)
return not (status[0] & RT_MASK_OFFLINE == RT_MASK_OFFLINE)

def paper_status(self) -> int: # could be IntEnum
"""Query the paper status of the printer.
Expand Down
5 changes: 3 additions & 2 deletions src/escpos/printer/cups.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import tempfile
from typing import Literal, Optional, Type, Union

from ..constants import RT_MASK_OFFLINE, RT_MASK_ONLINE
from ..escpos import Escpos
from ..exceptions import DeviceNotFoundError

Expand Down Expand Up @@ -206,8 +207,8 @@ def _read(self) -> bytes:
printer = self.printers.get(self.printer_name, {})
state = printer.get("printer-state")
if not state or state in [4, 5]:
return b"8" # offline
return b"0" # online
return bytes([RT_MASK_OFFLINE])
return bytes([RT_MASK_ONLINE])

def close(self) -> None:
"""Close CUPS connection.
Expand Down
31 changes: 28 additions & 3 deletions test/test_printers/test_printer_cups.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,33 @@ def test_printers_no_device(cupsprinter) -> None:
def test_read_no_device(cupsprinter) -> None:
"""
GIVEN a cups printer object
WHEN device is None
THEN check the return value is b'8'
WHEN device is None while querying for printer status
THEN check the return value is the byte '\x1a'
"""
cupsprinter.device = None
assert cupsprinter._read() == b"8"
assert cupsprinter._read() == bytes([26])


@pytest.mark.parametrize(
"state,expected",
[
pytest.param(3, bytes([18])),
pytest.param(4, bytes([26])),
pytest.param(5, bytes([26])),
],
)
def test_read(cupsprinter, mocker, state, expected) -> None:
"""
GIVEN a cups printer object and a mocked pycups device
WHEN querying for printer status
THEN check the return value is the expected
"""
mocker.patch("cups.Connection")
mocker.patch(
"escpos.printer.CupsPrinter.printers",
new={"test_printer": {"printer-state": state}},
)

cupsprinter.printer_name = "test_printer"

assert cupsprinter._read() == expected