cata_log_hub.utils.page_numbers module

class cata_log_hub.utils.page_numbers.PageNumber[source]

Bases: object

Pagenumber logic class.

__init__(page_number, start_number=0)[source]

Constructor for the pagenumber.

Parameters:

  • page_number (int) – The pagenumber.

  • start_number (int) – The number of the first page.

Return type:

None

__repr__()[source]

Representation of the pagenumber.

Return type:

str

Returns:

The string representation.

__str__()[source]

Convert the pagenumber as a string.

Return type:

str

Returns:

The pagenumber as a numeric string.

next()[source]

Get the next pagenumber.

Return type:

PageNumber

Returns:

The next pagenumber class.

prev()[source]

Get the previous pagenumber.

Return type:

PageNumber | None

Returns:

The previous pagenumber class. None if this is the first page.

as_double_page_number()[source]

Get the pagenumber as a double-pagenumber.

Return type:

DoublePageNumber

Returns:

The double-pagenumber class equivalent to this pagenumber.

property normalized: int

The normalized pagenumber.

class cata_log_hub.utils.page_numbers.DoublePageNumber[source]

Bases: object

Pagenumber logic class.

__init__(double_page_number, double_page_index, start_number=0)[source]

Constructor for the pagenumber.

Parameters:

  • double_page_number (int) – The pagenumber.

  • double_page_index (int) – The index of the page within the double page.

  • start_number (int) – The number of the first page.

Return type:

None

__repr__()[source]

Representation of the pagenumber.

Return type:

str

Returns:

The string representation.

next()[source]

Get the next double-pagenumber.

Return type:

DoublePageNumber

Returns:

The next double-pagenumber class.

prev()[source]

Get the previous double-pagenumber.

Return type:

DoublePageNumber | None

Returns:

The previous double-pagenumber class. None if this is the first double-page.

as_page_number()[source]

Get double-pagenumber as a pagenumber.

Return type:

PageNumber

Returns:

The pagenumber class equivalent to this double-pagenumber.

property number: int

Number of the double page.

Returns:

The number of this double page.

property side: int

Index of the double page side.

Returns:

The index of this page.

cata_log_hub.utils.page_numbers.page_numbering(start_number=0)[source]

Generator for a page numbering.

Parameters:

start_number (int) – The first page number.

Yields:

The consecutive page numbers starting with the first page number.

Return type:

Generator[PageNumber]