Builder Data Classes

Data Classes used to build Namecodes

class nautilus_namecodes.builder.namecode_builder_dataclasses.Block(name: str, description: Optional[str], sections: Iterable[nautilus_namecodes.builder.namecode_builder_dataclasses.Section], pages_minimum: dataclasses.InitVar[int] = 0)

A Group of Sections

get_block_codes(starting_codepoint: int, /) → nautilus_namecodes.namecodes_dataclasses.BlockCodes

Generate codes and return the filled BlockCodes Data Class

get_page_allocations() → list[int]

Get the number of allocated pages per Section

get_pages_allocated() → int

Return the number of allocated pages.

class nautilus_namecodes.builder.namecode_builder_dataclasses.CommonMethods

Methods that are common to all generation data classes.

abstract get_pages_allocated() → int

Return the number of allocated pages.

class nautilus_namecodes.builder.namecode_builder_dataclasses.CommonValues(name: str, description: Optional[str])

Attributes that are common all generation data classes.

class nautilus_namecodes.builder.namecode_builder_dataclasses.ConstantValues(page_size: int = 16)

Values that are constant over the entire generation process.

class nautilus_namecodes.builder.namecode_builder_dataclasses.Plane(name: str, description: Optional[str], blocks: list[nautilus_namecodes.builder.namecode_builder_dataclasses.Block])

A Logical Plane

get_block_page_allocations() → list[int]

Get the number of allocated pages per Block

get_pages_allocated() → int

Return the number of allocated pages.

get_plane_codes(starting_codepoint: int, /) → nautilus_namecodes.namecodes_dataclasses.PlaneCodes

Generate codes and return the filled PlaneCodes Data Class

class nautilus_namecodes.builder.namecode_builder_dataclasses.Section(name: str, description: Optional[str], values: list[str], name_value_format: str = '({name}) {value}')

Values over one or more page

static generate_pages_of_values(*, base_name: str, pages_to_use: int, gen_format: str) → list[str]

Static: Generate a full page of values from given format.

get_pages_allocated() → int

Return the number of allocated pages.

get_section_codes(starting_codepoint: int, /) → nautilus_namecodes.namecodes_dataclasses.SectionCodes

Generate codes and return the filled SectionsCode Data Class