diff --git a/fatamorgana/basic.py b/fatamorgana/basic.py index b65ffea..9861397 100644 --- a/fatamorgana/basic.py +++ b/fatamorgana/basic.py @@ -3,7 +3,7 @@ This module contains all datatypes and parsing/writing functions for all abstractions below the 'record' or 'block' level. """ from fractions import Fraction -from typing import List, Tuple, Type +from typing import List, Tuple, Type, Union, Optional, Any, Sequence from enum import Enum import math import struct @@ -20,9 +20,9 @@ except: ''' Type definitions ''' -real_t = int or float or Fraction -repetition_t = 'ReuseRepetition' or 'GridRepetition' or 'ArbitraryRepetition' -property_value_t = int or bytes or 'AString' or 'NString' or' PropStringReference' or float or Fraction +real_t = Union[int, float, Fraction] +repetition_t = Union['ReuseRepetition', 'GridRepetition', 'ArbitraryRepetition'] +property_value_t = Union[int, bytes, 'AString', 'NString', 'PropStringReference', float, Fraction] class FatamorganaError(Exception): @@ -69,11 +69,10 @@ class PathExtensionScheme(Enum): Arbitrary = 3 - ''' Constants ''' -MAGIC_BYTES = b'%SEMI-OASIS\r\n' # type: bytes +MAGIC_BYTES: bytes = b'%SEMI-OASIS\r\n' ''' @@ -84,10 +83,15 @@ def _read(stream: io.BufferedIOBase, n: int) -> bytes: Read n bytes from the stream. Raise an EOFError if there were not enough bytes in the stream. - :param stream: Stream to read from. - :param n: Number of bytes to read. - :return: The bytes that were read. - :raises: EOFError if not enough bytes could be read. + Args: + stream: Stream to read from. + n: Number of bytes to read. + + Returns: + The bytes that were read. + + Raises: + EOFError if not enough bytes could be read. """ b = stream.read(n) if len(b) != n: @@ -99,8 +103,11 @@ def read_byte(stream: io.BufferedIOBase) -> int: """ Read a single byte and return it. - :param stream: Stream to read from. - :return: The byte that was read. + Args: + stream: Stream to read from. + + Returns: + The byte that was read. """ return _read(stream, 1)[0] @@ -109,8 +116,11 @@ def write_byte(stream: io.BufferedIOBase, n: int) -> int: """ Write a single byte to the stream. - :param stream: Stream to read from. - :return: The number of bytes writen (1). + Args: + stream: Stream to read from. + + Returns: + The number of bytes writen (1). """ return stream.write(bytes((n,))) @@ -121,8 +131,11 @@ if _USE_NUMPY: Read a single byte from the stream, and interpret its bits as a list of 8 booleans. - :param stream: Stream to read from. - :return: A list of 8 booleans corresponding to the bits (MSB first). + Args: + stream: Stream to read from. + + Returns: + A list of 8 booleans corresponding to the bits (MSB first). """ byte_arr = _read(stream, 1) return numpy.unpackbits(numpy.frombuffer(byte_arr, dtype=numpy.uint8)) @@ -131,10 +144,15 @@ if _USE_NUMPY: """ Pack 8 booleans into a byte, and write it to the stream. - :param stream: Stream to write to. - :param bits: A list of 8 booleans corresponding to the bits (MSB first). - :return: Number of bytes written (1). - :raises: InvalidDataError if didn't receive 8 bits. + Args: + stream: Stream to write to. + bits: A list of 8 booleans corresponding to the bits (MSB first). + + Returns: + Number of bytes written (1). + + Raises: + InvalidDataError if didn't receive 8 bits. """ if len(bits) != 8: raise InvalidDataError('write_bool_byte received {} bits, requires 8'.format(len(bits))) @@ -145,21 +163,29 @@ else: Read a single byte from the stream, and interpret its bits as a list of 8 booleans. - :param stream: Stream to read from. - :return: A list of 8 booleans corresponding to the bits (MSB first). + Args: + stream: Stream to read from. + + Returns: + A list of 8 booleans corresponding to the bits (MSB first). """ byte = _read(stream, 1)[0] - bits = [(byte >> i) & 0x01 for i in reversed(range(8))] + bits = [bool((byte >> i) & 0x01) for i in reversed(range(8))] return bits def write_bool_byte(stream: io.BufferedIOBase, bits: Tuple[bool]) -> int: """ Pack 8 booleans into a byte, and write it to the stream. - :param stream: Stream to write to. - :param bits: A list of 8 booleans corresponding to the bits (MSB first). - :return: Number of bytes written (1). - :raises: InvalidDataError if didn't receive 8 bits. + Args: + stream: Stream to write to. + bits: A list of 8 booleans corresponding to the bits (MSB first). + + Returns: + Number of bytes written (1). + + Raises: + InvalidDataError if didn't receive 8 bits. """ if len(bits) != 8: raise InvalidDataError('write_bool_byte received {} bits, requires 8'.format(len(bits))) @@ -178,8 +204,11 @@ def read_uint(stream: io.BufferedIOBase) -> int: - Remaining bits of each byte form the binary representation of the integer, but are stored _least significant group first_. - :param stream: Stream to read from. - :return: The integer's value. + Args: + stream: Stream to read from. + + Returns: + The integer's value. """ result = 0 i = 0 @@ -195,12 +224,17 @@ def read_uint(stream: io.BufferedIOBase) -> int: def write_uint(stream: io.BufferedIOBase, n: int) -> int: """ Write an unsigned integer to the stream. - See format details in read_uint(...). + See format details in `read_uint()`. - :param stream: Stream to write to. - :param n: Value to write. - :return: The number of bytes written. - :raises: SignedError if n is negative. + Args: + stream: Stream to write to. + n: Value to write. + + Returns: + The number of bytes written. + + Raises: + SignedError: if `n` is negative. """ if n < 0: raise SignedError('uint must be positive: {}'.format(n)) @@ -227,8 +261,11 @@ def decode_sint(uint: int) -> int: - The LSB is treated as the sign bit - The remainder of the bits encodes the absolute value - :param uint: Unsigned integer to decode from. - :return: The decoded signed integer. + Args: + uint: Unsigned integer to decode from. + + Returns: + The decoded signed integer. """ return (uint >> 1) * (1 - 2 * (0x01 & uint)) @@ -236,10 +273,13 @@ def decode_sint(uint: int) -> int: def encode_sint(sint: int) -> int: """ Encode a signed integer into its corresponding unsigned integer form. - See decode_sint() for format details. + See `decode_sint()` for format details. - :param int: The signed integer to encode. - :return: Unsigned integer encoding for the input. + Args: + int: The signed integer to encode. + + Returns: + Unsigned integer encoding for the input. """ return (abs(sint) << 1) | (sint < 0) @@ -247,10 +287,13 @@ def encode_sint(sint: int) -> int: def read_sint(stream: io.BufferedIOBase) -> int: """ Read a signed integer from the stream. - See decode_sint() for format details. + See `decode_sint()` for format details. - :param stream: Stream to read from. - :return: The integer's value. + Args: + stream: Stream to read from. + + Returns: + The integer's value. """ return decode_sint(read_uint(stream)) @@ -258,11 +301,14 @@ def read_sint(stream: io.BufferedIOBase) -> int: def write_sint(stream: io.BufferedIOBase, n: int) -> int: """ Write a signed integer to the stream. - See decode_sint() for format details. + See `decode_sint()` for format details. - :param stream: Stream to write to. - :param n: Value to write. - :return: The number of bytes written. + Args: + stream: Stream to write to. + n: Value to write. + + Returns: + The number of bytes written. """ return write_uint(stream, encode_sint(n)) @@ -274,8 +320,11 @@ def read_bstring(stream: io.BufferedIOBase) -> bytes: - length: uint - data: bytes - :param stream: Stream to read from. - :return: Bytes containing the binary string. + Args: + stream: Stream to read from. + + Returns: + Bytes containing the binary string. """ length = read_uint(stream) return _read(stream, length) @@ -284,11 +333,14 @@ def read_bstring(stream: io.BufferedIOBase) -> bytes: def write_bstring(stream: io.BufferedIOBase, bstring: bytes): """ Write a binary string to the stream. - See read_bstring() for format details. + See `read_bstring()` for format details. - :param stream: Stream to write to. - :param bstring: Binary string to write. - :return: The number of bytes written. + Args: + stream: Stream to write to. + bstring: Binary string to write. + + Returns: + The number of bytes written. """ write_uint(stream, len(bstring)) return stream.write(bstring) @@ -301,8 +353,11 @@ def read_ratio(stream: io.BufferedIOBase) -> Fraction: - numerator: uint - denominator: uint - :param stream: Stream to read from. - :return: Fraction object containing the read value. + Args: + stream: Stream to read from. + + Returns: + Fraction object containing the read value. """ numer = read_uint(stream) denom = read_uint(stream) @@ -312,12 +367,17 @@ def read_ratio(stream: io.BufferedIOBase) -> Fraction: def write_ratio(stream: io.BufferedIOBase, r: Fraction) -> int: """ Write an unsigned ratio to the stream. - See read_ratio() for format details. + See `read_ratio()` for format details. - :param stream: Stream to write to. - :param r: Ratio to write (Fraction object). - :return: The number of bytes written. - :raises: SignedError if r is negative. + Args: + stream: Stream to write to. + r: Ratio to write (`Fraction` object). + + Returns: + The number of bytes written. + + Raises: + SignedError: if r is negative. """ if r < 0: raise SignedError('Ratio must be unsigned: {}'.format(r)) @@ -330,8 +390,11 @@ def read_float32(stream: io.BufferedIOBase) -> float: """ Read a 32-bit float from the stream. - :param stream: Stream to read from. - :return: The value read. + Args: + stream: Stream to read from. + + Returns: + The value read. """ b = _read(stream, 4) return struct.unpack(" int: """ Write a 32-bit float to the stream. - :param stream: Stream to write to. - :param f: Value to write. - :return: The number of bytes written (4). + Arsg: + stream: Stream to write to. + f: Value to write. + + Returns: + The number of bytes written (4). """ b = struct.pack(" float: """ Read a 64-bit float from the stream. - :param stream: Stream to read from. - :return: The value read. + Args: + stream: Stream to read from. + + Returns: + The value read. """ b = _read(stream, 8) return struct.unpack(" int: """ Write a 64-bit float to the stream. - :param stream: Stream to write to. - :param f: Value to write. - :return: The number of bytes written (8). + Args: + stream: Stream to write to. + f: Value to write. + + Returns: + The number of bytes written (8). """ b = struct.pack(" real_t: 6: 32-bit float 7: 64-bit float - :param stream: Stream to read from. - :param real_type: Type of real number to read. If None (default), - the type is read from the stream. - :return: The value read. - :raises: InvalidDataError if real_type is invalid. + Args: + stream: Stream to read from. + real_type: Type of real number to read. If `None` (default), + the type is read from the stream. + + Returns: + The value read. + + Raises: + InvalidDataError: if real_type is invalid. """ if real_type is None: @@ -431,10 +508,14 @@ def write_real(stream: io.BufferedIOBase, Since python has no 32-bit floats, the force_float32 parameter will perform the cast at write-time if set to True (default False). - :param stream: Stream to write to. - :param r: Value to write. - :param float32: - :return: The number of bytes written. + Args: + stream: Stream to write to. + r: Value to write. + force_float32: If `True`, casts r to float32 when writing. + Default `False`. + + Returns: + The number of bytes written. """ size = 0 if isinstance(r, int): @@ -462,15 +543,16 @@ class NString: Class for handling "name strings", which hold one or more printable ASCII characters (0x21 to 0x7e, inclusive). - __init__ can be called with either a string or bytes object; - subsequent reading/writing should use the .string and - .bytes properties. + `__init__` can be called with either a string or bytes object; + subsequent reading/writing should use the `string` and + `bytes` properties. """ - _string = None # type: str + _string: str - def __init__(self, string_or_bytes: bytes or str): + def __init__(self, string_or_bytes: Union[bytes, str]): """ - :param string_or_bytes: Content of the Nstring. + Args: + string_or_bytes: Content of the `NString`. """ if isinstance(string_or_bytes, str): self.string = string_or_bytes @@ -494,7 +576,7 @@ class NString: @bytes.setter def bytes(self, bstring: bytes): if len(bstring) == 0 or not all(0x21 <= c <= 0x7e for c in bstring): - raise InvalidDataError('Invalid n-string {}'.format(bstring)) + raise InvalidDataError('Invalid n-string {!r}'.format(bstring)) self._string = bstring.decode('ascii') @staticmethod @@ -502,9 +584,14 @@ class NString: """ Create an NString object by reading a bstring from the provided stream. - :param stream: Stream to read from. - :return: Resulting NString. - :raises: InvalidDataError + Args: + stream: Stream to read from. + + Returns: + Resulting NString. + + Raises: + InvalidDataError """ return NString(read_bstring(stream)) @@ -512,12 +599,15 @@ class NString: """ Write this NString to a stream. - :param stream: Stream to write to. - :return: Number of bytes written. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. """ return write_bstring(stream, self.bytes) - def __eq__(self, other: 'NString') -> bool: + def __eq__(self, other: Any) -> bool: return isinstance(other, type(self)) and self.string == other.string def __repr__(self) -> str: @@ -527,11 +617,16 @@ class NString: def read_nstring(stream: io.BufferedIOBase) -> str: """ Read a name string from the provided stream. - See NString for constraints on name strings. + See `NString` for constraints on name strings. - :param stream: Stream to read from. - :return: Resulting string. - :raises: InvalidDataError + Args: + stream: Stream to read from. + + Returns: + Resulting string. + + Raises: + InvalidDataError """ return NString.read(stream).string @@ -539,12 +634,17 @@ def read_nstring(stream: io.BufferedIOBase) -> str: def write_nstring(stream: io.BufferedIOBase, string: str) -> int: """ Write a name string to a stream. - See NString for constraints on name strings. + See `NString` for constraints on name strings. - :param stream: Stream to write to. - :param string: String to write. - :return: Number of bytes written. - :raises: InvalidDataError + Args: + stream: Stream to write to. + string: String to write. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError """ return NString(string).write(stream) @@ -554,15 +654,16 @@ class AString: Class for handling "ascii strings", which hold zero or more ASCII characters (0x20 to 0x7e, inclusive). - __init__ can be called with either a string or bytes object; - subsequent reading/writing should use the .string and - .bytes properties. + `__init__` can be called with either a string or bytes object; + subsequent reading/writing should use the `string` and + `bytes` properties. """ - _string = None # type: str + _string: str - def __init__(self, string_or_bytes: bytes or str): + def __init__(self, string_or_bytes: Union[bytes, str]): """ - :param string_or_bytes: Content of the AString. + Args: + string_or_bytes: Content of the AString. """ if isinstance(string_or_bytes, str): self.string = string_or_bytes @@ -586,30 +687,38 @@ class AString: @bytes.setter def bytes(self, bstring: bytes): if not all(0x20 <= c <= 0x7e for c in bstring): - raise InvalidDataError('Invalid a-string {}'.format(bstring)) + raise InvalidDataError('Invalid a-string {!r}'.format(bstring)) self._string = bstring.decode('ascii') @staticmethod def read(stream: io.BufferedIOBase) -> 'AString': """ - Create an AString object by reading a bstring from the provided stream. + Create an `AString` object by reading a bstring from the provided stream. - :param stream: Stream to read from. - :return: Resulting AString. - :raises: InvalidDataError + Args: + stream: Stream to read from. + + Returns: + Resulting `AString`. + + Raises: + InvalidDataError """ return AString(read_bstring(stream)) def write(self, stream: io.BufferedIOBase) -> int: """ - Write this AString to a stream. + Write this `AString` to a stream. - :param stream: Stream to write to. - :return: Number of bytes written. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. """ return write_bstring(stream, self.bytes) - def __eq__(self, other: 'AString') -> bool: + def __eq__(self, other: Any) -> bool: return isinstance(other, type(self)) and self.string == other.string def __repr__(self) -> str: @@ -619,11 +728,16 @@ class AString: def read_astring(stream: io.BufferedIOBase) -> str: """ Read an ASCII string from the provided stream. - See AString for constraints on ASCII strings. + See `AString` for constraints on ASCII strings. - :param stream: Stream to read from. - :return: Resulting string. - :raises: InvalidDataError + Args: + stream: Stream to read from. + + Returns: + Resulting string. + + Raises: + InvalidDataError """ return AString.read(stream).string @@ -633,10 +747,15 @@ def write_astring(stream: io.BufferedIOBase, string: str) -> int: Write an ASCII string to a stream. See AString for constraints on ASCII strings. - :param stream: Stream to write to. - :param string: String to write. - :return: Number of bytes written. - :raises: InvalidDataError + Args: + stream: Stream to write to. + string: String to write. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError """ return AString(string).write(stream) @@ -645,19 +764,20 @@ class ManhattanDelta: """ Class representing an axis-aligned ("Manhattan") vector. - Has properties - .vertical (boolean, true if aligned along y-axis) - .value (int, signed length of the vector) + Attributes: + vertical (bool): `True` if aligned along y-axis + value (int): signed length of the vector """ vertical = None # type: bool value = None # type: int def __init__(self, x: int, y: int): """ - One of x or y _must_ be zero! + One of `x` or `y` _must_ be zero! - :param x: x-displacement - :param y: y-displacement + Args: + x: x-displacement + y: y-displacement """ x = int(x) y = int(y) @@ -674,7 +794,8 @@ class ManhattanDelta: """ Return a list representation of this vector. - :return: [x, y] + Returns: + `[x, y]` """ xy = [0, 0] xy[self.vertical] = self.value @@ -683,9 +804,10 @@ class ManhattanDelta: def as_uint(self) -> int: """ Return this vector encoded as an unsigned integer. - See ManhattanDelta.from_uint() for format details. + See `ManhattanDelta.from_uint()` for format details. - :return: uint encoding of this vector. + Returns: + uint encoding of this vector. """ return (encode_sint(self.value) << 1) | self.vertical @@ -697,42 +819,51 @@ class ManhattanDelta: The LSB of the encoded object is 1 if the vector is aligned to the y-axis, or 0 if aligned to the x-axis. The remaining bits are used to encode a signed integer containing - the signed length of the vector (see encode_sint() for format details). + the signed length of the vector (see `encode_sint()` for format details). - :param n: Unsigned integer representation of a ManhattanDelta vector. - :return: The ManhattanDelta object that was encoded by n. + Args: + n: Unsigned integer representation of a `ManhattanDelta` vector. + + Returns: + The `ManhattanDelta` object that was encoded by `n`. """ d = ManhattanDelta(0, 0) d.value = decode_sint(n >> 1) - d.vertical = n & 0x01 + d.vertical = bool(n & 0x01) return d @staticmethod def read(stream: io.BufferedIOBase) -> 'ManhattanDelta': """ - Read a ManhattanDelta object from the provided stream. + Read a `ManhattanDelta` object from the provided stream. - See .from_uint() for format details. + See `ManhattanDelta.from_uint()` for format details. - :param stream: The stream to read from. - :return: The ManhattanDelta object that was read from the stream. + Args: + stream: The stream to read from. + + Returns: + The `ManhattanDelta` object that was read from the stream. """ n = read_uint(stream) return ManhattanDelta.from_uint(n) def write(self, stream: io.BufferedIOBase) -> int: """ - Write a ManhattanDelta object to the provided stream. + Write a `ManhattanDelta` object to the provided stream. - See .from_uint() for format details. + See `ManhattanDelta.from_uint()` for format details. - :param stream: The stream to write to. - :return: The number of bytes written. + Args: + stream: The stream to write to. + + Returns: + The number of bytes written. """ return write_uint(stream, self.as_uint()) - def __eq__(self, other: 'ManhattanDelta') -> bool: - return hasattr(other, as_list) and self.as_list() == other.as_list() + def __eq__(self, other: Any) -> bool: + return hasattr(other, 'as_list') and self.as_list() == other.as_list() def __repr__(self) -> str: return '{}'.format(self.as_list()) @@ -742,9 +873,9 @@ class OctangularDelta: """ Class representing an axis-aligned or 45-degree ("Octangular") vector. - Has properties - .proj_mag (int, projection of the vector onto the x or y axis (non-zero)) - .octangle (int, bitfield: + Attributes: + proj_mag (int): projection of the vector onto the x or y axis (non-zero) + octangle (int): bitfield: bit 2: 1 if non-axis-aligned (non-Manhattan) if Manhattan: bit 1: 1 if direction is negative @@ -757,17 +888,17 @@ class OctangularDelta: 0: +x, 1: +y, 2: -x, 3: -y, 4: +x+y, 5: -x+y, 6: +x-y, 7: -x-y - ) """ - proj_mag = None # type: int - octangle = None # type: int + proj_mag: int + octangle: int def __init__(self, x: int, y: int): """ - Either abs(x)==abs(y), x==0, or y==0 _must_ be true! + Either `abs(x)==abs(y)`, `x==0`, or `y==0` _must_ be true! - :param x: x-displacement - :param y: y-displacement + Args: + x: x-displacement + y: y-displacement """ x = int(x) y = int(y) @@ -789,7 +920,8 @@ class OctangularDelta: """ Return a list representation of this vector. - :return: [x, y] + Returns: + `[x, y]` """ if self.octangle < 4: xy = [0, 0] @@ -808,24 +940,28 @@ class OctangularDelta: def as_uint(self) -> int: """ Return this vector encoded as an unsigned integer. - See OctangularDelta.from_uint() for format details. + See `OctangularDelta.from_uint()` for format details. - :return: uint encoding of this vector. + Returns: + uint encoding of this vector. """ return (self.proj_mag << 3) | self.octangle @staticmethod def from_uint(n: int) -> 'OctangularDelta': """ - Construct an OctangularDelta object from its unsigned integer encoding. + Construct an `OctangularDelta` object from its unsigned integer encoding. - The low 3 bits are equal to .proj_mag, as specified in the class + The low 3 bits are equal to `proj_mag`, as specified in the class docstring. The remaining bits are used to encode an unsigned integer containing the length of the vector. - :param n: Unsigned integer representation of an OctangularDelta vector. - :return: The OctangularDelta object that was encoded by n. + Args: + n: Unsigned integer representation of an `OctangularDelta` vector. + + Returns: + The `OctangularDelta` object that was encoded by `n`. """ d = OctangularDelta(0, 0) d.proj_mag = n >> 3 @@ -835,29 +971,35 @@ class OctangularDelta: @staticmethod def read(stream: io.BufferedIOBase) -> 'OctangularDelta': """ - Read an OctangularDelta object from the provided stream. + Read an `OctangularDelta` object from the provided stream. - See .from_uint() for format details. + See `OctangularDelta.from_uint()` for format details. - :param stream: The stream to read from. - :return: The OctangularDelta object that was read from the stream. + Args: + stream: The stream to read from. + + Returns: + The `OctangularDelta` object that was read from the stream. """ n = read_uint(stream) return OctangularDelta.from_uint(n) def write(self, stream: io.BufferedIOBase) -> int: """ - Write an OctangularDelta object to the provided stream. + Write an `OctangularDelta` object to the provided stream. - See .from_uint() for format details. + See `OctangularDelta.from_uint()` for format details. - :param stream: The stream to write to. - :return: The number of bytes written. + Args: + stream: The stream to write to. + + Returns: + The number of bytes written. """ return write_uint(stream, self.as_uint()) - def __eq__(self, other: 'OctangularDelta') -> bool: - return hasattr(other, as_list) and self.as_list() == other.as_list() + def __eq__(self, other: Any) -> bool: + return hasattr(other, 'as_list') and self.as_list() == other.as_list() def __repr__(self) -> str: return '{}'.format(self.as_list()) @@ -867,17 +1009,18 @@ class Delta: """ Class representing an arbitrary vector - Has properties - .x (int) - .y (int) + Attributes + x (int): x-displacement + y (int): y-displacement """ - x = None # type: int - y = None # type: int + x: int + y: int def __init__(self, x: int, y: int): """ - :param x: x-displacement - :param y: y-displacement + Args: + x: x-displacement + y: y-displacement """ x = int(x) y = int(y) @@ -888,25 +1031,29 @@ class Delta: """ Return a list representation of this vector. - :return: [x, y] + Returns: + `[x, y]` """ return [self.x, self.y] @staticmethod def read(stream: io.BufferedIOBase) -> 'Delta': """ - Read a Delta object from the provided stream. + Read a `Delta` object from the provided stream. The format consists of one or two unsigned integers. The LSB of the first integer is 1 if a second integer is present. If two integers are present, the remaining bits of the first - integer are an encoded signed integer (see encode_sint()), and + integer are an encoded signed integer (see `encode_sint()`), and the second integer is an encoded signed_integer. Otherwise, the remaining bits of the first integer are an encoded - OctangularData (see OctangularData.from_uint()). + `OctangularData` (see `OctangularData.from_uint()`). - :param stream: The stream to read from. - :return: The Delta object that was read from the stream. + Args: + stream: The stream to read from. + + Returns: + The `Delta` object that was read from the stream. """ n = read_uint(stream) if (n & 0x01) == 0: @@ -918,12 +1065,15 @@ class Delta: def write(self, stream: io.BufferedIOBase) -> int: """ - Write a Delta object to the provided stream. + Write a `Delta` object to the provided stream. - See .from_uint() for format details. + See `Delta.from_uint()` for format details. - :param stream: The stream to write to. - :return: The number of bytes written. + Args: + stream: The stream to write to. + + Returns: + The number of bytes written. """ if self.x == 0 or self.y == 0 or abs(self.x) == abs(self.y): return write_uint(stream, OctangularDelta(self.x, self.y).as_uint() << 1) @@ -932,8 +1082,8 @@ class Delta: size += write_uint(stream, encode_sint(self.y)) return size - def __eq__(self, other: 'Delta') -> bool: - return hasattr(other, as_list) and self.as_list() == other.as_list() + def __eq__(self, other: Any) -> bool: + return hasattr(other, 'as_list') and self.as_list() == other.as_list() def __repr__(self) -> str: return '{}'.format(self.as_list()) @@ -943,8 +1093,14 @@ def read_repetition(stream: io.BufferedIOBase) -> repetition_t: """ Read a repetition entry from the given stream. - :param stream: Stream to read from. - :return: The repetition entry. + Args: + stream: Stream to read from. + + Returns: + The repetition entry. + + Raises: + InvalidDataError: if an unexpected repetition type is read """ rtype = read_uint(stream) if rtype == 0: @@ -961,9 +1117,12 @@ def write_repetition(stream: io.BufferedIOBase, repetition: repetition_t) -> int """ Write a repetition entry to the given stream. - :param stream: Stream to write to. - :param repetition: The repetition entry to write. - :return: The number of bytes written. + Args: + stream: Stream to write to. + repetition: The repetition entry to write. + + Returns: + The number of bytes written. """ return repetition.write(stream) @@ -980,7 +1139,7 @@ class ReuseRepetition: def write(self, stream: io.BufferedIOBase) -> int: return write_uint(stream, 0) - def __eq__(self, other: 'ReuseRepetition') -> bool: + def __eq__(self, other: Any) -> bool: return isinstance(other, ReuseRepetition) def __repr__(self) -> str: @@ -994,37 +1153,40 @@ class GridRepetition: two lattice vectors, and the extent of the grid is stored as the number of elements along each lattice vector. - This class has properties - .a_vector ([xa: int, ya: int], vector specifying a center-to-center - displacement between adjacent elements in the grid.) - .b_vector ([xb: int, yb: int] or None, a second displacement, present if - a 2D grid is being specified.) - .a_count (int >= 1, number of elements along the grid axis specified by - .a_vector) - .b_count (int >= 1 or None, number of elements along the grid axis - specified by .b_vector) + Attributes: + a_vector (Tuple[int, int]): `(xa, ya)` vector specifying a center-to-center + displacement between adjacent elements in the grid. + b_vector (Optional[Tuple[int, int]]): `(xb, yb)`, a second displacement, + present if a 2D grid is being specified. + a_count (int): number of elements (>=1) along the grid axis specified by + `a_vector`. + b_count (Optional[int]): Number of elements (>=1) along the grid axis + specified by `b_vector`, if `b_vector` is not `None`. """ - a_vector = None # type: List[int] - b_vector = None # type: List[int] or None - a_count = None # type: int - b_count = None # type: int or None + a_vector: List[int] + b_vector: Optional[List[int]] = None + a_count: int + b_count: Optional[int] = None def __init__(self, a_vector: List[int], a_count: int, - b_vector: List[int] = None, - b_count: int = None): + b_vector: Optional[List[int]] = None, + b_count: Optional[int] = None): """ - :param a_vector: First lattice vector, of the form [x, y]. - Specifies center-to-center spacing between adjacent elements. - :param a_count: Number of elements in the a_vector direction. - :param b_vector: Second lattice vector, of the form [x, y]. - Specifies center-to-center spacing between adjacent elements. - Can be omitted when specifying a 1D array. - :param b_count: Number of elements in the b_vector direction. - Should be omitted if b_vector was omitted. - :raises: InvalidDataError if b_* inputs conflict with each other - or a_count < 1. + Args: + a_vector: First lattice vector, of the form `[x, y]`. + Specifies center-to-center spacing between adjacent elements. + a_count: Number of elements in the a_vector direction. + b_vector: Second lattice vector, of the form `[x, y]`. + Specifies center-to-center spacing between adjacent elements. + Can be omitted when specifying a 1D array. + b_count: Number of elements in the `b_vector` direction. + Should be omitted if `b_vector` was omitted. + + Raises: + InvalidDataError: if `b_count` and `b_vector` inputs conflict + with each other or if `a_count < 1`. """ self.a_vector = a_vector self.b_vector = b_vector @@ -1054,14 +1216,21 @@ class GridRepetition: @staticmethod def read(stream: io.BufferedIOBase, repetition_type: int) -> 'GridRepetition': """ - Read a GridRepetition from a stream. + Read a `GridRepetition` from a stream. - :param stream: Stream to read from. - :param repetition_type: Repetition type as defined in OASIS repetition spec. - Valid types are 1, 2, 3, 8, 9. - :return: GridRepetition object read from stream. - :raises InvalidDataError if repetition_type is invalid. + Args: + stream: Stream to read from. + repetition_type: Repetition type as defined in OASIS repetition spec. + Valid types are 1, 2, 3, 8, 9. + + Returns: + `GridRepetition` object read from stream. + + Raises: + InvalidDataError: if `repetition_type` is invalid. """ + nb: Optional[int] + b_vector: Optional[List[int]] if repetition_type == 1: na = read_uint(stream) + 2 nb = read_uint(stream) + 2 @@ -1094,14 +1263,19 @@ class GridRepetition: def write(self, stream: io.BufferedIOBase) -> int: """ - Write the GridRepetition to a stream. + Write the `GridRepetition` to a stream. - A minimal representation is written (e.g., if b_count==1, + A minimal representation is written (e.g., if `b_count==1`, a 1D grid is written) - :param stream: Stream to write to. - :return: Number of bytes written. - :raises: InvalidDataError if repetition is malformed. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError: if repetition is malformed. """ if self.b_vector is None or self.b_count is None: if self.b_vector is not None or self.b_count is not None: @@ -1140,7 +1314,7 @@ class GridRepetition: size += Delta(*self.b_vector).write(stream) return size - def __eq__(self, other: 'GridRepetition') -> bool: + def __eq__(self, other: Any) -> bool: return isinstance(other, type(self)) and \ self.a_count == other.a_count and \ self.b_count == other.b_count and \ @@ -1157,20 +1331,21 @@ class ArbitraryRepetition: Class representing a repetition entry denoting a 1D or 2D array of arbitrarily-spaced elements. - Properties: - .x_displacements (List[int], x-displacements between elements) - .y_displacements (List[int], y-displacements between elements) + Attributes: + x_displacements (List[int]): x-displacements between consecutive elements + y_displacements (List[int]): y-displacements between consecutive elements """ - x_displacements = None # type: List[int] - y_displacements = None # type: List[int] + x_displacements: List[int] + y_displacements: List[int] def __init__(self, x_displacements: List[int], y_displacements: List[int]): """ - :param x_displacements: x-displacements between consecutive elements - :param y_displacements: y-displacements between consecutive elements + Args: + x_displacements: x-displacements between consecutive elements + y_displacements: y-displacements between consecutive elements """ self.x_displacements = x_displacements self.y_displacements = y_displacements @@ -1178,13 +1353,18 @@ class ArbitraryRepetition: @staticmethod def read(stream: io.BufferedIOBase, repetition_type: int) -> 'ArbitraryRepetition': """ - Read an ArbitraryRepetition from a stream. + Read an `ArbitraryRepetition` from a stream. - :param stream: Stream to read from. - :param repetition_type: Repetition type as defined in OASIS repetition spec. - Valid types are 4, 5, 6, 7, 10, 11. - :return: ArbitraryRepetition object read from stream. - :raises InvalidDataError if repetition_type is invalid. + Args: + stream: Stream to read from. + repetition_type: Repetition type as defined in OASIS repetition spec. + Valid types are 4, 5, 6, 7, 10, 11. + + Returns: + `ArbitraryRepetition` object read from stream. + + Raises: + InvalidDataError: if `repetition_type` is invalid. """ if repetition_type == 4: n = read_uint(stream) + 1 @@ -1227,14 +1407,17 @@ class ArbitraryRepetition: def write(self, stream: io.BufferedIOBase) -> int: """ - Write the ArbitraryRepetition to a stream. + Write the `ArbitraryRepetition` to a stream. A minimal representation is attempted; common factors in the displacements will be factored out, and lists of zeroes will be omitted. - :param stream: Stream to write to. - :return: Number of bytes written. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. """ def get_gcd(vals: List[int]) -> int: """ @@ -1288,7 +1471,7 @@ class ArbitraryRepetition: return size - def __eq__(self, other: 'ArbitraryRepetition') -> bool: + def __eq__(self, other: Any) -> bool: return isinstance(other, type(self)) and self.x_displacements == other.x_displacements and self.y_displacements == other.y_displacements def __repr__(self) -> str: @@ -1299,8 +1482,14 @@ def read_point_list(stream: io.BufferedIOBase) -> List[List[int]]: """ Read a point list from a stream. - :param stream: Stream to read from. - :return: Point list of the form [[x0, y0], [x1, y1], ...] + Args: + stream: Stream to read from. + + Returns: + Point list of the form `[[x0, y0], [x1, y1], ...]` + + Raises: + InvalidDataError: if an invalid list type is read. """ list_type = read_uint(stream) list_len = read_uint(stream) @@ -1361,24 +1550,27 @@ def read_point_list(stream: io.BufferedIOBase) -> List[List[int]]: def write_point_list(stream: io.BufferedIOBase, - points: List[List[int]], + points: List[Sequence[int]], fast: bool = False, implicit_closed: bool = True ) -> int: """ Write a point list to a stream. - :param stream: Stream to write to. - :param points: List of points, of the form [[x0, y0], [x1, y1], ...] - :param fast: If True, avoid searching for a compact representation for - the point list. - :param implicit_closed: Set to True if the list represents an implicitly - closed polygon, i.e. there is an implied line segment from points[-1] - to points[0]. If False, such segments are ignored, which can result in a - more compact representation for non-closed paths (e.g. a Manhattan - path with non-colinear endpoints). If unsure, use the default. - Default True. - :return: Number of bytes written. + Args: + stream: Stream to write to. + points: List of points, of the form `[[x0, y0], [x1, y1], ...]` + fast: If `True`, avoid searching for a compact representation for + the point list. + implicit_closed: Set to True if the list represents an implicitly + closed polygon, i.e. there is an implied line segment from `points[-1]` + to `points[0]`. If False, such segments are ignored, which can result in + a more compact representation for non-closed paths (e.g. a Manhattan + path with non-colinear endpoints). If unsure, use the default. + Default `True`. + + Returns: + Number of bytes written. """ # If we're in a hurry, just write the points as arbitrary Deltas if fast: @@ -1480,12 +1672,12 @@ class PropStringReference: """ Reference to a property string. - Properties: - .ref (int, ID of the target) - .ref_type (Type, Type of the target: bytes, NString, or AString) + Attributes: + ref (int): ID of the target + ref_type (Type): Type of the target: `bytes`, `NString`, or `AString` """ - ref = None # type: int - reference_type = None # type: Type + ref: int + reference_type: Type def __init__(self, ref: int, ref_type: Type): """ @@ -1495,7 +1687,7 @@ class PropStringReference: self.ref = ref self.ref_type = ref_type - def __eq__(self, other: 'PropStringReference') -> bool: + def __eq__(self, other: Any) -> bool: return isinstance(other, type(self)) and self.ref == other.ref and self.reference_type == other.reference_type def __repr__(self) -> str: @@ -1513,16 +1705,21 @@ def read_property_value(stream: io.BufferedIOBase) -> property_value_t: 0...7: real number; property value type is reused for real number type 8: unsigned integer 9: signed integer - 10: ASCII string (AString) - 11: binary string (bytes) - 12: name string (NString) - 13: PropstringReference to AString - 14: PropstringReference to bstring (i.e., to bytes) - 15: PropstringReference to NString + 10: ASCII string (`AString`) + 11: binary string (`bytes`) + 12: name string (`NString`) + 13: `PropstringReference` to `AString` + 14: `PropstringReference` to `bstring` (i.e., to `bytes`) + 15: `PropstringReference` to `NString` - :param stream: Stream to read from. - :return: Value of the property, depending on type. - :raises: InvalidDataError if an invalid type is read. + Args: + stream: Stream to read from. + + Returns: + Value of the property, depending on type. + + Raises: + InvalidDataError: if an invalid type is read. """ prop_type = read_uint(stream) if 0 <= prop_type <= 7: @@ -1562,18 +1759,21 @@ def write_property_value(stream: io.BufferedIOBase, """ Write a property value to a stream. - See read_property_value() for format details. + See `read_property_value()` for format details. - :param stream: Stream to write to. - :param value: Property value to write. Can be an integer, a real number, - bytes (bstring), NString, AString, or a PropstringReference. - :param force_real: If True and value is an integer, writes an integer- - valued real number instead of a plain integer. Default False. - :param force_signed_int: If True and value is a positive integer, - writes a signed integer. Default false. - :param force_float32: If True and value is a float, writes a 32-bit - float (real number) instead of a 64-bit float. - :return: Number of bytes written. + Args: + stream: Stream to write to. + value: Property value to write. Can be an integer, a real number, + `bytes` (`bstring`), `NString`, `AString`, or a `PropstringReference`. + force_real: If `True` and value is an integer, writes an integer- + valued real number instead of a plain integer. Default `False`. + force_signed_int: If `True` and value is a positive integer, + writes a signed integer. Default `False`. + force_float32: If `True` and value is a float, writes a 32-bit + float (real number) instead of a 64-bit float. + + Returns: + Number of bytes written. """ if isinstance(value, int) and not force_real: if force_signed_int or value < 0: @@ -1606,7 +1806,7 @@ def write_property_value(stream: io.BufferedIOBase, return size -def read_interval(stream: io.BufferedIOBase) -> Tuple[int or None]: +def read_interval(stream: io.BufferedIOBase) -> Tuple[Optional[int], Optional[int]]: """ Read an interval from a stream. These are used for storing layer info. @@ -1619,10 +1819,13 @@ def read_interval(stream: io.BufferedIOBase) -> Tuple[int or None]: type 3: a, a (unsigned integer a) type 4: a, b (unsigned integers a, b) - :param stream: Stream to read from. - :return: (lower, upper), where - lower can be None if there is an implicit lower bound of 0 - upper can be None if there is no upper bound (inf) + Args: + stream: Stream to read from. + + Returns: + `(lower, upper)`, where + `lower` can be `None` if there is an implicit lower bound of `0` + `upper` can be `None` if there is no upper bound (`inf`) """ interval_type = read_uint(stream) if interval_type == 0: @@ -1639,17 +1842,20 @@ def read_interval(stream: io.BufferedIOBase) -> Tuple[int or None]: def write_interval(stream: io.BufferedIOBase, - min_bound: int or None = None, - max_bound: int or None = None + min_bound: Optional[int] = None, + max_bound: Optional[int] = None ) -> int: """ Write an interval to a stream. - Used for layer data; see read_interval for format details. + Used for layer data; see `read_interval()` for format details. - :param stream: Stream to write to. - :param min_bound: Lower bound on the interval, can be None (implicit 0, default) - :param max_bound: Upper bound on the interval, can be None (unbounded, default) - :return: Number of bytes written. + Args: + stream: Stream to write to. + min_bound: Lower bound on the interval, can be None (implicit 0, default) + max_bound: Upper bound on the interval, can be None (unbounded, default) + + Returns: + Number of bytes written. """ if min_bound is None: if max_bound is None: @@ -1670,33 +1876,31 @@ class OffsetEntry: """ Entry for the file's offset table. - Properties: - .strict (bool, If False, the records pointed to by this - offset entry may also appear elsewhere in the file. - If True, all records of the type pointed to by this - offset entry must be present in a contiuous block at - the specified offset [pad records also allowed]. - Additionally: - All references to strict-mode records must be - explicit (using reference_number). - The offset may point to an encapsulating CBlock - record, if the first record in that CBlock is - of the target record type. A strict mode table - cannot begin in the middle of a CBlock. - ) - .offset (int, offset from the start of the file; may be 0 - for records that are not present.) + Attributes: + strict (bool): If `False`, the records pointed to by this + offset entry may also appear elsewhere in the file. If `True`, all + records of the type pointed to by this offset entry must be present + in a contiuous block at the specified offset [pad records also allowed]. + Additionally: + - All references to strict-mode records must be + explicit (using reference_number). + - The offset may point to an encapsulating CBlock record, if the first + record in that CBlock is of the target record type. A strict modei + table cannot begin in the middle of a CBlock. + offset (int): offset from the start of the file; may be 0 + for records that are not present. """ - strict = False # type: bool - offset = 0 # type: int + strict: bool = False + offset: int = 0 def __init__(self, strict: bool = False, offset: int = 0): """ - :param strict: True if the records referenced are written in - strict mode (see class docstring). Default False. - :param offset: Offset from the start of the file for the - referenced records; may be 0 if records are absent. - Default 0. + Args: + strict: `True` if the records referenced are written in + strict mode (see class docstring). Default `False`. + offset: Offset from the start of the file for the + referenced records; may be `0` if records are absent. + Default `0`. """ self.strict = strict self.offset = offset @@ -1706,8 +1910,11 @@ class OffsetEntry: """ Read an offset entry from a stream. - :param stream: Stream to read from. - :return: Offset entry that was read. + Args: + stream: Stream to read from. + + Returns: + Offset entry that was read. """ entry = OffsetEntry() entry.strict = read_uint(stream) > 0 @@ -1718,8 +1925,11 @@ class OffsetEntry: """ Write this offset entry to a stream. - :param stream: Stream to write to. - :return: Number of bytes written + Args: + stream: Stream to write to. + + Returns: + Number of bytes written """ return write_uint(stream, self.strict) + write_uint(stream, self.offset) @@ -1741,20 +1951,20 @@ class OffsetTable: which are stored in the above order in the file's offset table. - Proerties: - .cellnames (OffsetEntry) - .textstrings (OffsetEntry) - .propnames (OffsetEntry) - .propstrings (OffsetEntry) - .layernames (OffsetEntry) - .xnames (OffsetEntry) + Attributes: + cellnames (OffsetEntry): Offset for CellNames + textstrings (OffsetEntry): Offset for TextStrings + propnames (OffsetEntry): Offset for PropNames + propstrings (OffsetEntry): Offset for PropStrings + layernames (OffsetEntry): Offset for LayerNames + xnames (OffsetEntry): Offset for XNames """ - cellnames = None # type: OffsetEntry - textstrings= None # type: OffsetEntry - propnames = None # type: OffsetEntry - propstrings = None # type: OffsetEntry - layernames = None # type: OffsetEntry - xnames = None # type: OffsetEntry + cellnames: OffsetEntry = None + textstrings: OffsetEntry = None + propnames: OffsetEntry = None + propstrings: OffsetEntry = None + layernames: OffsetEntry = None + xnames: OffsetEntry = None def __init__(self, cellnames: OffsetEntry = None, @@ -1764,14 +1974,15 @@ class OffsetTable: layernames: OffsetEntry = None, xnames: OffsetEntry = None): """ - All parameters default to a non-strict entry with offset 0. + All parameters default to a non-strict entry with offset `0`. - :param cellnames: OffsetEntry for CellName records. - :param textstrings: OffsetEntry for TextString records. - :param propnames: OffsetEntry for PropName records. - :param propstrings: OffsetEntry for PropString records. - :param layernames: OffsetEntry for LayerNamerecords. - :param xnames: OffsetEntry for XName records. + Args: + cellnames: `OffsetEntry` for `CellName` records. + textstrings: `OffsetEntry` for `TextString` records. + propnames: `OffsetEntry` for `PropName` records. + propstrings: `OffsetEntry` for `PropString` records. + layernames: `OffsetEntry` for `LayerName` records. + xnames: `OffsetEntry` for `XName` records. """ if cellnames is None: cellnames = OffsetEntry() @@ -1799,8 +2010,11 @@ class OffsetTable: Read an offset table from a stream. See class docstring for format details. - :param stream: Stream to read from. - :return: The offset table that was read. + Args: + stream: Stream to read from. + + Returns: + The offset table that was read. """ table = OffsetTable() table.cellnames = OffsetEntry.read(stream) @@ -1816,8 +2030,11 @@ class OffsetTable: Write this offset table to a stream. See class docstring for format details. - :param stream: Stream to write to. - :return: Number of bytes written. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. """ size = self.cellnames.write(stream) size += self.textstrings.write(stream) @@ -1836,8 +2053,11 @@ def read_u32(stream: io.BufferedIOBase) -> int: """ Read a 32-bit unsigned integer (little endian) from a stream. - :param stream: Stream to read from. - :return: The integer that was read. + Args: + stream: Stream to read from. + + Returns: + The integer that was read. """ b = _read(stream, 4) return struct.unpack(' int: """ Write a 32-bit unsigned integer (little endian) to a stream. - :param stream: Stream to write to. - :param n: Integer to write. - :return: The number of bytes written (4). - :raises: SignedError if n is negative. + Args: + stream: Stream to write to. + n: Integer to write. + + Returns: + The number of bytes written (4). + + Raises: + SignedError: if `n` is negative. """ if n < 0: raise SignedError('Negative u32: {}'.format(n)) @@ -1866,20 +2091,22 @@ class Validation: The checksum is calculated using the entire file, excluding the final 4 bytes (the value of the checksum itself). - Properties: - .checksum_type (int, 0: No checksum, 1: crc32, 2: checksum32) - .checksum (int or None, value of the checksum) - + Attributes: + checksum_type (int): `0` for no checksum, `1` for crc32, `2` for checksum32 + checksum (Optional[int]): value of the checksum """ - checksum_type = None # type: int - checksum = None # type: int or None + checksum_type: int + checksum: Optional[int] = None def __init__(self, checksum_type: int, checksum: int = None): """ - :param checksum_type: 0,1,2 (No checksum, crc32, checksum32) - :param checksum: Value of the checksum, or None. - :raises: InvalidDataError if checksum_type is invalid, or - unexpected checksum is present. + Args: + checksum_type: 0,1,2 (No checksum, crc32, checksum32) + checksum: Value of the checksum, or None. + + Raises: + InvalidDataError: if `checksum_type` is invalid, or + unexpected `checksum` is present. """ if checksum_type < 0 or checksum_type > 2: raise InvalidDataError('Invalid validation type') @@ -1894,9 +2121,14 @@ class Validation: Read a validation entry from a stream. See class docstring for format details. - :param stream: Stream to read from. - :return: The validation entry that was read. - :raises: InvalidDataError if an invalid validation type was encountered. + Args: + stream: Stream to read from. + + Returns: + The validation entry that was read. + + Raises: + InvalidDataError: if an invalid validation type was encountered. """ checksum_type = read_uint(stream) if checksum_type == 0: @@ -1914,8 +2146,11 @@ class Validation: Write this validation entry to a stream. See class docstring for format details. - :param stream: Stream to write to. - :return: Number of bytes written. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. """ if self.checksum_type == 0: return write_uint(stream, 0) @@ -1932,8 +2167,11 @@ def write_magic_bytes(stream: io.BufferedIOBase) -> int: """ Write the magic byte sequence to a stream. - :param stream: Stream to write to. - :return: Number of bytes written. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. """ return stream.write(MAGIC_BYTES) @@ -1941,10 +2179,13 @@ def write_magic_bytes(stream: io.BufferedIOBase) -> int: def read_magic_bytes(stream: io.BufferedIOBase): """ Read the magic byte sequence from a stream. - Raise an InvalidDataError if it was not found. + Raise an `InvalidDataError` if it was not found. - :param stream: Stream to read from. - :raises: InvalidDataError if the sequence was not found. + Args: + stream: Stream to read from. + + Raises: + InvalidDataError: if the sequence was not found. """ magic = _read(stream, len(MAGIC_BYTES)) if magic != MAGIC_BYTES: diff --git a/fatamorgana/main.py b/fatamorgana/main.py index 3cc721c..8fca84e 100644 --- a/fatamorgana/main.py +++ b/fatamorgana/main.py @@ -3,6 +3,7 @@ This module contains data structures and functions for reading from and writing to whole OASIS layout files, and provides a few additional abstractions for the data contained inside them. """ +from typing import List, Dict, Union, Optional import io import logging @@ -23,17 +24,17 @@ class FileModals: """ File-scoped modal variables """ - cellname_implicit = None # type: bool or None - propname_implicit = None # type: bool or None - xname_implicit = None # type: bool or None - textstring_implicit = None # type: bool or None - propstring_implicit = None # type: bool or None - cellname_implicit = None # type: bool or None + cellname_implicit: Optional[bool] = None + propname_implicit: Optional[bool] = None + xname_implicit: Optional[bool] = None + textstring_implicit: Optional[bool] = None + propstring_implicit: Optional[bool] = None + cellname_implicit: Optional[bool] = None - within_cell = False # type: bool - within_cblock = False # type: bool - end_has_offset_table = None # type: bool - started = False # type: bool + within_cell: bool = False + within_cblock: bool = False + end_has_offset_table: bool + started: bool = False class OasisLayout: @@ -43,49 +44,51 @@ class OasisLayout: Names and strings are stored in dicts, indexed by reference number. Layer names and properties are stored directly using their associated record objects. - Cells are stored using Cell objects (different from Cell record objects). + Cells are stored using `Cell` objects (different from `records.Cell` + record objects). - Properties: - File properties: - .version AString: Version string ('1.0') - .unit real number: grid steps per micron - .validation Validation: checksum data + Attributes: + (File properties) + version (AString): Version string ('1.0') + unit (real_t): grid steps per micron + validation (Validation): checksum data - Names: - .cellnames Dict[int, NString] - .propnames Dict[int, NString] - .xnames Dict[int, XName] + (Names) + cellnames (Dict[int, NString]): Cell names + propnames (Dict[int, NString]): Property names + xnames (Dict[int, XName]): Custom names - Strings: - .textstrings Dict[int, AString] - .propstrings Dict[int, AString] + (Strings) + textstrings (Dict[int, AString]): Text strings + propstrings (Dict[int, AString]): Property strings - Data: - .layers List[records.LayerName] - .properties List[records.Property] - .cells List[Cell] + (Data) + layers (List[records.LayerName]): Layer definitions + properties (List[records.Property]): Property values + cells (List[Cell]): Layout cells """ - version = None # type: AString - unit = None # type: real_t - validation = None # type: Validation + version: AString + unit: real_t + validation: Validation - properties = None # type: List[records.Property] - cells = None # type: List[Cell] + properties: List[records.Property] + cells: List['Cell'] - cellnames = None # type: Dict[int, NString] - propnames = None # type: Dict[int, NString] - xnames = None # type: Dict[int, XName] + cellnames: Dict[int, NString] + propnames: Dict[int, NString] + xnames: Dict[int, 'XName'] - textstrings = None # type: Dict[int, AString] - propstrings = None # type: Dict[int, AString] - layers = None # type: List[records.LayerName] + textstrings: Dict[int, AString] + propstrings: Dict[int, AString] + layers: List[records.LayerName] def __init__(self, unit: real_t, validation: Validation = None): """ - :param unit: Real number (i.e. int, float, or Fraction), grid steps per micron. - :param validation: Validation object containing checksum data. - Default creates a Validation object of the "no checksum" type. + Args: + unit: Real number (i.e. int, float, or `Fraction`), grid steps per micron. + validation: `Validation` object containing checksum data. + Default creates a `Validation` object of the "no checksum" type. """ if validation is None: validation = Validation(0) @@ -105,10 +108,13 @@ class OasisLayout: @staticmethod def read(stream: io.BufferedIOBase) -> 'OasisLayout': """ - Read an entire .oas file into an OasisLayout object. + Read an entire .oas file into an `OasisLayout` object. - :param stream: Stream to read from. - :return: New OasisLayout object. + Args: + stream: Stream to read from. + + Returns: + New `OasisLayout` object. """ file_state = FileModals() modals = Modals() @@ -127,15 +133,20 @@ class OasisLayout: ) -> bool: """ Read a single record of unspecified type from a stream, adding its - contents into this OasisLayout object. + contents into this `OasisLayout` object. - :param stream: Stream to read from. - :param modals: Modal variable data, used to fill unfilled record - fields and updated using filled record fields. - :param file_state: File status data. - :return: True if EOF was reached without error, False otherwise. - :raises: InvalidRecordError from unexpected records; - InvalidDataError from within record parsers. + Args: + stream: Stream to read from. + modals: Modal variable data, used to fill unfilled record + fields and updated using filled record fields. + file_state: File status data. + + Returns: + `True` if EOF was reached without error, `False` otherwise. + + Raises: + InvalidRecordError: from unexpected records + InvalidDataError: from within record parsers """ try: record_id = read_uint(stream) @@ -304,9 +315,14 @@ class OasisLayout: """ Write this object in OASIS fromat to a stream. - :param stream: Stream to write to. - :return: Number of bytes written. - :raises: InvalidDataError if contained records are invalid. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError: if contained records are invalid. """ modals = Modals() @@ -357,21 +373,22 @@ class Cell: """ Representation of an OASIS cell. - Properties: - .name NString or int (CellName reference number) + Attributes: + name (Union[NString, int]): name or "CellName reference" number - .properties List of records.Property - .placements List of records.Placement - .geometry List of geometry record objectes + properties (List[records.Property]): Properties of this cell + placements (List[records.Placement]): Placement record objects + geometry: (List[records.geometry_t]): Geometry record objectes """ - name = None # type: NString or int - properties = None # type: List[records.Property] - placements = None # type: List[records.Placement] - geometry = None # type: List[records.geometry_t] + name: Union[NString, int] + properties: List[records.Property] + placements: List[records.Placement] + geometry: List[records.geometry_t] - def __init__(self, name: NString or int): + def __init__(self, name: Union[NString, int]): """ - :param name: NString or int (CellName reference number) + Args: + name: `NString` or "CellName reference" number """ self.name = name self.properties = [] @@ -383,10 +400,15 @@ class Cell: Write this cell to a stream, using the provided modal variables to deduplicate any repeated data. - :param stream: Stream to write to. - :param modals: Modal variables to use for deduplication. - :return: Number of bytes written. - :raises: InvalidDataError if contained records are invalid. + Args: + stream: Stream to write to. + modals: Modal variables to use for deduplication. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError: if contained records are invalid. """ size = records.Cell(self.name).dedup_write(stream, modals) size += sum(p.dedup_write(stream, modals) for p in self.properties) @@ -399,16 +421,17 @@ class XName: """ Representation of an XName. - This class is effectively a simplified form of a records.XName, + This class is effectively a simplified form of a `records.XName`, with the reference data stripped out. """ - attribute = None # type: int - bstring = None # type: bytes + attribute: int + bstring: bytes def __init__(self, attribute: int, bstring: bytes): """ - :param attribute: Attribute number. - :param bstring: Binary data. + Args: + attribute: Attribute number. + bstring: Binary data. """ self.attribute = attribute self.bstring = bstring @@ -416,10 +439,13 @@ class XName: @staticmethod def from_record(record: records.XName) -> 'XName': """ - Create an XName object from a records.XName record. + Create an `XName` object from a `records.XName` record. - :param record: XName record to use. - :return: XName object. + Args: + record: XName record to use. + + Returns: + `XName` object. """ return XName(record.attribute, record.bstring) diff --git a/fatamorgana/records.py b/fatamorgana/records.py index 842f201..3d81f14 100644 --- a/fatamorgana/records.py +++ b/fatamorgana/records.py @@ -11,7 +11,7 @@ Higher-level code (e.g. monitoring for combinations of records with in main.py instead. """ from abc import ABCMeta, abstractmethod -from typing import List, Dict, Tuple +from typing import List, Dict, Tuple, Union, Optional, Sequence import copy import math import zlib @@ -35,42 +35,43 @@ logger = logging.getLogger(__name__) ''' Type definitions ''' -geometry_t = 'Text' or 'Rectangle' or 'Polygon' or 'Path' or 'Trapezoid' or \ - 'CTrapezoid' or 'Circle' or 'XElement' or 'XGeometry' -pathextension_t = Tuple['PathExtensionScheme' or int] +geometry_t = Union['Text', 'Rectangle', 'Polygon', 'Path', 'Trapezoid', + 'CTrapezoid', 'Circle', 'XElement', 'XGeometry'] +pathextension_t = Tuple['PathExtensionScheme', Optional[int]] +point_list_t = Sequence[Sequence[int]] class Modals: """ - Modal variables, used to store data about previously-written ori + Modal variables, used to store data about previously-written or -read records. """ - repetition = None # type: repetition_t or None - placement_x = 0 # type: int - placement_y = 0 # type: int - placement_cell = None # type: int or NString or None - layer = None # type: int or None - datatype = None # type: int or None - text_layer = None # type: int or None - text_datatype = None # type: int or None - text_x = 0 # type: int - text_y = 0 # type: int - text_string = None # type: AString or int or None - geometry_x = 0 # type: int - geometry_y = 0 # type: int - xy_relative = False # type: bool - geometry_w = None # type: int or None - geometry_h = None # type: int or None - polygon_point_list = None # type: List[List[int]] or None - path_halfwidth = None # type: int or None - path_point_list = None # type: List[List[int]] or None - path_extension_start = None # type: pathextension_t or None - path_extension_end = None # type: pathextension_t or None - ctrapezoid_type = None # type: int or None - circle_radius = None # type: int or None - property_value_list = None # type: List[property_value_t] or None - property_name = None # type: int or NString or None - property_is_standard = None # type: bool or None + repetition: Optional[repetition_t] = None + placement_x: int = 0 + placement_y: int = 0 + placement_cell: Optional[NString] = None + layer: Optional[int] = None + datatype: Optional[int] = None + text_layer: Optional[int] = None + text_datatype: Optional[int] = None + text_x: int = 0 + text_y: int = 0 + text_string: Union[AString, int, None] = None + geometry_x: int = 0 + geometry_y: int = 0 + xy_relative: bool = False + geometry_w: Optional[int] = None + geometry_h: Optional[int] = None + polygon_point_list: Optional[point_list_t] = None + path_half_width: Optional[int] = None + path_point_list: Optional[point_list_t] = None + path_extension_start: Optional[pathextension_t] = None + path_extension_end: Optional[pathextension_t] = None + ctrapezoid_type: Optional[int] = None + circle_radius: Optional[int] = None + property_value_list: Optional[Sequence[property_value_t]] = None + property_name: Union[int, NString, None] = None + property_is_standard: Optional[bool] = None def __init__(self): self.reset() @@ -79,9 +80,9 @@ class Modals: """ Resets all modal variables to their default values. Default values are: - 0 for placement_{x,y}, text_{x,y}, geometry_{x,y} - False for xy_relative - Undefined (None) for all others + `0` for placement_{x,y}, text_{x,y}, geometry_{x,y} + `False` for xy_relative + Undefined (`None`) for all others """ self.repetition = None self.placement_x = 0 @@ -100,7 +101,7 @@ class Modals: self.geometry_w = None self.geometry_h = None self.polygon_point_list = None - self.path_halfwidth = None + self.path_half_width = None self.path_point_list = None self.path_extension_start = None self.path_extension_end = None @@ -127,7 +128,8 @@ class Record(metaclass=ABCMeta): Copy all defined values from this record into the modal variables. Fill all undefined values in this record from the modal variables. - :param modals: Modal variables to merge with. + Args: + modals: Modal variables to merge with. """ pass @@ -140,7 +142,8 @@ class Record(metaclass=ABCMeta): used instead. Update the modal variables using the remaining (unequal) values. - :param modals: Modal variables to deduplicate with. + Args: + modals: Modal variables to deduplicate with. """ pass @@ -151,12 +154,17 @@ class Record(metaclass=ABCMeta): Read a record of this type from a stream. This function does not merge with modal variables. - :param stream: Stream to read from. - :param record_id: Record id of the record to read. The + Args: + stream: Stream to read from. + record_id: Record id of the record to read. The record id is often used to specify which variant of the record is stored. - :return: The record that was read. - :raises: InvalidDataError if the record is malformed. + + Returns: + The record that was read. + + Raises: + InvalidDataError: if the record is malformed. """ pass @@ -166,20 +174,30 @@ class Record(metaclass=ABCMeta): Write this record to a stream as-is. This function does not merge or deduplicate with modal variables. - :param stream: Stream to write to. - :return: Number of bytes written. - :raises: InvalidDataError if the record contains invalid data. + Args: + stream: Stream to write to. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError: if the record contains invalid data. """ pass def dedup_write(self, stream: io.BufferedIOBase, modals: Modals) -> int: """ - Run .deduplicate_with_modals() and then .write() to the stream. + Run `.deduplicate_with_modals()` and then `.write()` to the stream. - :param stream: Stream to write to. - :param modals: Modal variables to merge with. - :return: Number of bytes written - :raises: InvalidDataError if the record contains invalid data. + Args: + stream: Stream to write to. + modals: Modal variables to merge with. + + Returns: + Number of bytes written. + + Raises: + InvalidDataError: if the record contains invalid data. """ # TODO logging #print(type(self), stream.tell()) @@ -190,7 +208,8 @@ class Record(metaclass=ABCMeta): """ Perform a deep copy of this record. - :return: A deep copy of this record. + Returns: + A deep copy of this record. """ return copy.deepcopy(self) @@ -201,15 +220,18 @@ class Record(metaclass=ABCMeta): def read_refname(stream: io.BufferedIOBase, is_present: bool, is_reference: bool - ) -> None or int or NString: + ) -> Union[None, int, NString]: """ Helper function for reading a possibly-absent, possibly-referenced NString. - :param stream: Stream to read from. - :param is_present: If False, read nothing and return None - :param is_reference: If True, read a uint (reference id), - otherwise read an NString. - :return: None, reference id, or NString + Args: + stream: Stream to read from. + is_present: If `False`, read nothing and return `None` + is_reference: If `True`, read a uint (reference id), + otherwise read an `NString`. + + Returns: + `None`, reference id, or `NString` """ if not is_present: return None @@ -222,15 +244,18 @@ def read_refname(stream: io.BufferedIOBase, def read_refstring(stream: io.BufferedIOBase, is_present: bool, is_reference: bool - ) -> None or int or AString: + ) -> Union[None, int, AString]: """ - Helper function for reading a possibly-absent, possibly-referenced AString. + Helper function for reading a possibly-absent, possibly-referenced `AString`. - :param stream: Stream to read from. - :param is_present: If False, read nothing and return None - :param is_reference: If True, read a uint (reference id), - otherwise read an AString. - :return: None, reference id, or AString + Args: + stream: Stream to read from. + is_present: If `False`, read nothing and return `None` + is_reference: If `True`, read a uint (reference id), + otherwise read an `AString`. + + Returns: + `None`, reference id, or `AString` """ if not is_present: return None @@ -267,10 +292,10 @@ class XYMode(Record): """ XYMode record (ID 15, 16) - Properties: - .relative (bool, default False) + Attributes: + relative (bool): default `False` """ - relative = False # type: bool + relative: bool = False @property def absolute(self) -> bool: @@ -282,7 +307,8 @@ class XYMode(Record): def __init__(self, relative: bool): """ - :param relative: True if the mode is 'relative', False if 'absolute'. + Args: + relative: `True` if the mode is 'relative', `False` if 'absolute'. """ self.relative = relative @@ -308,25 +334,26 @@ class Start(Record): """ Start Record (ID 1) - Properties: - .version (AString, "1.0") - .unit (positive real number, grid steps per micron) - .offset_table (OffsetTable or None, if None then table must be - placed in the End record) + Attributes: + version (AString): "1.0" + unit (real_t): positive real number, grid steps per micron + offset_table (OffsetTable or None): If `None` then table must be + placed in the `End` record) """ - version = None # type: AString - unit = None # type: real_t - offset_table = None # type: OffsetTable + version: AString + unit: real_t + offset_table: OffsetTable = None def __init__(self, unit: real_t, - version: AString or str = None, + version: Union[AString, str] = None, offset_table: OffsetTable = None): """ - :param unit: Grid steps per micron (positive real number) - :param version: Version string, default "1.0" - :param offset_table: OffsetTable for the file, or None to place - it in the End record instead. + Args + unit: Grid steps per micron (positive real number) + version: Version string, default "1.0" + offset_table: `OffsetTable` for the file, or `None` to place + it in the `End` record instead. """ if unit <= 0: raise InvalidDataError('Non-positive unit: {}'.format(unit)) @@ -387,21 +414,22 @@ class End(Record): The end record is always padded to a total length of 256 bytes. - Properties: - .offset_table (OffsetTable or None, None if offset table was - written into the Start record instead) - .validation (Validation object) + Attributes: + offset_table (Optional[OffsetTable]): `None` if offset table was + written into the `Start` record instead + validation (Validation): object containing checksum """ - offset_table = None # type: OffsetTable or None - validation = None # type: Validation + offset_table: Optional[OffsetTable] = None + validation: Validation def __init__(self, validation: Validation, - offset_table: OffsetTable = None): + offset_table: Optional[OffsetTable] = None): """ - :param validation: Validation object for this file. - :param offset_table: OffsetTable, or None if the Start record - contained an OffsetTable. Default None. + Args: + validation: `Validation` object for this file. + offset_table: `OffsetTable`, or `None` if the `Start` record + contained an `OffsetTable`. Default `None`. """ self.validation = validation self.offset_table = offset_table @@ -450,23 +478,24 @@ class CBlock(Record): """ CBlock (Compressed Block) record (ID 34) - Properties: - .compression_type (int, 0 for zlib) - .decompressed_byte_count (int) - .compressed_bytes (bytes) + Attributes: + compression_type (int): `0` for zlib + decompressed_byte_count (int): size after decompressing + compressed_bytes (bytes): compressed data """ - compression_type = None # type: int - decompressed_byte_count = None # type: int - compressed_bytes = None # type: bytes + compression_type: int + decompressed_byte_count: int + compressed_bytes: bytes def __init__(self, compression_type: int, decompressed_byte_count: int, compressed_bytes: bytes): """ - :param compression_type: 0 (zlib) - :param decompressed_byte_count: Number of bytes in the decompressed data. - :param compressed_bytes: The compressed data. + Args: + compression_type: `0` (zlib) + decompressed_byte_count: Number of bytes in the decompressed data. + compressed_bytes: The compressed data. """ if compression_type != 0: raise InvalidDataError('CBlock: Invalid compression scheme ' @@ -509,11 +538,16 @@ class CBlock(Record): """ Create a CBlock record from uncompressed data. - :param decompressed_bytes: Uncompressed data (one or more non-CBlock records) - :param compression_type: Compression type (0: zlib). Default 0 - :param compression_args Passed as kwargs to zlib.compressobj(). Default {}. - :return: CBlock object constructed from the data. - :raises: InvalidDataError if invalid compression_type. + Args: + decompressed_bytes: Uncompressed data (one or more non-CBlock records) + compression_type: Compression type (0: zlib). Default `0` + compression_args: Passed as kwargs to `zlib.compressobj()`. Default `{}`. + + Returns: + CBlock object constructed from the data. + + Raises: + InvalidDataError: if invalid `compression_type`. """ if compression_args is None: compression_args = {} @@ -533,9 +567,14 @@ class CBlock(Record): """ Decompress the contents of this CBlock. - :param decompression_args: Passed as kwargs to zlib.decompressobj(). - :return: Decompressed bytes object. - :raises: InvalidDataError if data is malformed or compression type is + Args: + decompression_args: Passed as kwargs to `zlib.decompressobj()`. + + Returns: + Decompressed `bytes` object. + + Raises: + InvalidDataError: if data is malformed or compression type is unknonwn. """ if decompression_args is None: @@ -556,20 +595,21 @@ class CellName(Record): """ CellName record (ID 3, 4) - Properties: - .nstring (NString) - .reference_number (int or None) + Attributes: + nstring (NString): name + reference_number (Optional[int]): `None` results in implicit assignment """ - nstring = None # type: NString - reference_number = None # type: int or None + nstring: NString + reference_number: Optional[int] = None def __init__(self, - nstring: NString or str, + nstring: Union[NString, str], reference_number: int = None): """ - :param nstring: The contained string. - :param reference_number: Reference id number for the string. - Default is to use an implicitly-assigned number. + Args: + nstring: The contained string. + reference_number: Reference id number for the string. + Default is to use an implicitly-assigned number. """ if isinstance(nstring, NString): self.nstring = nstring @@ -609,20 +649,21 @@ class PropName(Record): """ PropName record (ID 7, 8) - Properties: - .nstring (NString) - .reference_number (int or None) + Attributes: + nstring (NString): name + reference_number (Optional[int]): `None` results in implicit assignment """ - nstring = None # type: NString - reference_number = None # type: int or None + nstring: NString + reference_number: Optional[int] = None def __init__(self, - nstring: NString or str, + nstring: Union[NString, str], reference_number: int = None): """ - :param nstring: The contained string. - :param reference_number: Reference id number for the string. - Default is to use an implicitly-assigned number. + Args: + nstring: The contained string. + reference_number: Reference id number for the string. + Default is to use an implicitly-assigned number. """ if isinstance(nstring, NString): self.nstring = nstring @@ -663,20 +704,21 @@ class TextString(Record): """ TextString record (ID 5, 6) - Properties: - .astring (AString) - .reference_number (int or None) + Attributes: + astring (AString): string data + reference_number (Optional[int]): `None` results in implicit assignment """ - astring = None # type: AString - reference_number = None # type: int or None + astring: AString + reference_number: Optional[int] = None def __init__(self, - string: AString or str, + string: Union[AString, str], reference_number: int = None): """ - :param string: The contained string. - :param reference_number: Reference id number for the string. - Default is to use an implicitly-assigned number. + Args: + string: The contained string. + reference_number: Reference id number for the string. + Default is to use an implicitly-assigned number. """ if isinstance(string, AString): self.astring = string @@ -717,20 +759,21 @@ class PropString(Record): """ PropString record (ID 9, 10) - Properties: - .astring (AString) - .reference_number (int or None) + Attributes: + astring (AString): string data + reference_number (Optional[int]): `None` results in implicit assignment """ - astring = None # type: AString - reference_number = None # type: int or None + astring: AString + reference_number: Optional[int] = None def __init__(self, - string: AString or str, + string: Union[AString, str], reference_number: int = None): """ - :param string: The contained string. - :param reference_number: Reference id number for the string. - Default is to use an implicitly-assigned number. + Args: + string: The contained string. + reference_number: Reference id number for the string. + Default is to use an implicitly-assigned number. """ if isinstance(string, AString): self.astring = string @@ -771,31 +814,30 @@ class LayerName(Record): """ LayerName record (ID 11, 12) - Properties: - .nstring (NString) - .layer_interval (Tuple, (int or None, int or None), - bounds on the interval) - .type_interval (Tuple, (int or None, int or None), - bounds on the interval) - .is_textlayer (bool) + Attributes: + nstring (NString): name + layer_interval (Tuple[Optional[int], Optional[int]]): bounds on the interval + type_interval (Tuple[Optional[int], Optional[int]]): bounds on the interval + is_textlayer (bool): Is this a text layer? """ - nstring = None # type: NString, - layer_interval = None # type: Tuple - type_interval = None # type: Tuple - is_textlayer = None # type: bool + nstring: NString + layer_interval: Tuple + type_interval: Tuple + is_textlayer: bool def __init__(self, - nstring: NString or str, + nstring: Union[NString, str], layer_interval: Tuple, type_interval: Tuple, is_textlayer: bool): """ - :param nstring: The layer name. - :param layer_interval: Tuple (int or None, int or None) giving bounds - (or lack of thereof) on the layer number. - :param type_interval: Tuple (int or None, int or None) giving bounds - (or lack of thereof) on the type number. - :param is_textlayer: True if the layer is a text layer. + Args: + nstring: The layer name. + layer_interval: Tuple (int or None, int or None) giving bounds + (or lack of thereof) on the layer number. + type_interval: Tuple (int or None, int or None) giving bounds + (or lack of thereof) on the type number. + is_textlayer: `True` if the layer is a text layer. """ if isinstance(nstring, NString): self.nstring = nstring @@ -837,28 +879,28 @@ class Property(Record): """ LayerName record (ID 28, 29) - Properties: - .name (NString or int or None, - int is an explicit reference, - None is a flag to use Modal) - .values (List of property values or None) - .is_standard (bool, whether this is a standard property) + Attributes: + name (Union[NString, int, None]): `int` is an explicit reference, + `None` is a flag to use Modal) + values (Optional[List[property_value_t]]): List of property values. + is_standard (bool): Whether this is a standard property. """ - name = None # type: NString or int or None, - values = None # type: List[property_value_t] or None - is_standard = None # type: bool or None + name: Union[NString, int, None] = None + values: Optional[List[property_value_t]] = None + is_standard: Optional[bool] = None def __init__(self, - name: NString or str or int = None, - values: List[property_value_t] = None, - is_standard: bool = None): + name: Union[NString, str, int] = None, + values: Optional[List[property_value_t]] = None, + is_standard: Optional[bool] = None): """ - :param name: Property name, reference number, or None (i.e. use modal) - Default None. - :param values: List of property values, or None (i.e. use modal) - Default None. - :param is_standard: True if this is a standard property. None to use modal. - Default None. + Args: + name: Property name, reference number, or `None` (i.e. use modal) + Default `None. + values: List of property values, or `None` (i.e. use modal) + Default `None`. + is_standard: `True` if this is a standard property. `None` to use modal. + Default `None`. """ if isinstance(name, str): self.name = NString(name) @@ -948,24 +990,25 @@ class XName(Record): """ XName record (ID 30, 31) - Properties: - .attribute (int) - .bstring (bytes) - .reference_number (int or None, None means to use implicity numbering) + Attributes: + attribute (int): Attribute number + bstring (bytes): XName data + reference_number (Optional[int]): None means to use implicit numbering """ - attribute = None # type: int - bstring = None # type: bytes - reference_number = None # type: int or None + attribute: int + bstring: bytes + reference_number: Optional[int] = None def __init__(self, attribute: int, bstring: bytes, reference_number: int = None): """ - :param attribute: Attribute number. - :param bstring: Binary XName data. - :param reference_number: Reference number for this XName. - Default None (implicit). + Args: + attribute: Attribute number. + bstring: Binary XName data. + reference_number: Reference number for this `XName`. + Default `None` (implicit). """ self.attribute = attribute self.bstring = bstring @@ -1006,17 +1049,18 @@ class XElement(Record): """ XElement record (ID 32) - Properties: - .attribute (int) - .bstring (bytes) + Attributes: + attribute (int): Attribute number. + bstring (bytes): XElement data. """ - attribute = None # type: int - bstring = None # type: bytes + attribute: int + bstring: bytes def __init__(self, attribute: int, bstring: bytes): """ - :param attribute: Attribute number. - :param bstring: Binary data for this XElement. + Args: + attribute: Attribute number. + bstring: Binary data for this XElement. """ self.attribute = attribute self.bstring = bstring @@ -1049,22 +1093,22 @@ class XGeometry(Record): """ XGeometry record (ID 33) - Properties: - .attribute (int) - .bstring (bytes) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means reuse modal) - .y (int or None, None means reuse modal) - .repetition (reptetition or None) + Attributes: + attribute (int): Attribute number. + bstring (bytes): XGeometry data. + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): None means reuse modal + y (Optional[int]): None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - attribute = None # type: int - bstring = None # type: bytes - layer = None # type: int or None - datatype = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None + attribute: int + bstring: bytes + layer: Optional[int] = None + datatype: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None def __init__(self, attribute: int, @@ -1075,13 +1119,14 @@ class XGeometry(Record): y: int = None, repetition: repetition_t = None): """ - :param attribute: Attribute number for this XGeometry. - :param bstring: Binary data for this XGeometry. - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). + Args: + attribute: Attribute number for this XGeometry. + bstring: Binary data for this XGeometry. + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). """ self.attribute = attribute self.bstring = bstring @@ -1158,14 +1203,15 @@ class Cell(Record): """ Cell record (ID 13, 14) - Properties: - .name (NString or int specifying CellName reference number) + Attributes: + name (Union[int, NString]): int specifies "CellName reference" number """ - name = None # type: int or NString + name: Union[int, NString] - def __init__(self, name: int or NString): + def __init__(self, name: Union[int, NString]): """ - :param name: NString, or an int specifying a CellName reference number. + Args: + name: `NString`, or an int specifying a `CellName` reference number. """ self.name = name @@ -1203,44 +1249,43 @@ class Placement(Record): """ Placement record (ID 17, 18) - Properties: - .attribute (int) - .name (NString, name or - int, CellName reference number or - None, reuse modal) - .magnification (real) - .angle (real, degrees counterclockwise) - .x (int or None, None means reuse modal) - .y (int or None, None means reuse modal) - .repetition (reptetition or None) - .flip (bool) + Attributes: + name (Union[NString, int, None]): name, "CellName reference" + number, or reuse modal + magnification (real_t): Magnification factor + angle (real_t): Rotation, degrees counterclockwise + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (repetition_t or None): Repetition, if any + flip (bool): Whether to perform reflection about the x-axis. """ - name = None # type: NString or int or None - magnification = None # type: real_t or None - angle = None # type: real_t or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None - flip = None # type: bool + name: Union[NString, int, None] = None + magnification: Optional[real_t] = None + angle: Optional[real_t] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None + flip: bool def __init__(self, flip: bool, - name: NString or str or int = None, - magnification: real_t = None, - angle: real_t = None, - x: int = None, - y: int = None, - repetition: repetition_t = None): + name: Union[NString, str, int] = None, + magnification: Optional[real_t] = None, + angle: Optional[real_t] = None, + x: Optional[int] = None, + y: Optional[int] = None, + repetition: Optional[repetition_t] = None): """ - :param flip: Whether to perform reflection about the x-axis. - :param name: NString, an int specifying a CellName reference number, - or None (reuse modal). - :param magnification: Magnification factor. Default None (use modal). - :param angle: Rotation angle in degrees, counterclockwise. - Default None (reuse modal). - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). + Args: + flip: Whether to perform reflection about the x-axis. + name: `NString`, an int specifying a `CellName` reference number, + or `None` (reuse modal). + magnification: Magnification factor. Default `None` (use modal). + angle: Rotation angle in degrees, counterclockwise. + Default `None` (reuse modal). + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). """ self.x = x self.y = y @@ -1340,36 +1385,37 @@ class Text(Record): """ Text record (ID 19) - Properties: - .string (AString or int or None, None means reuse modal) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means reuse modal) - .y (int or None, None means reuse modal) - .repetition (reptetition or None) + Attributes: + string (Union[AString, int, None]): None means reuse modal + layer (Optiona[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - string = None # type: AString or int or None - layer = None # type: int or None - datatype = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None + string: Union[AString, int, None] = None + layer: Optional[int] = None + datatype: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None def __init__(self, - string: AString or str or int = None, - layer: int = None, - datatype: int = None, - x: int = None, - y: int = None, - repetition: repetition_t = None): + string: Union[AString, str, int] = None, + layer: Optional[int] = None, + datatype: Optional[int] = None, + x: Optional[int] = None, + y: Optional[int] = None, + repetition: Optional[repetition_t] = None): """ - :param string: Text content, or TextString reference number. - Default None (use modal). - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). + Args: + string: Text content, or `TextString` reference number. + Default `None` (use modal). + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). """ self.layer = layer self.datatype = datatype @@ -1455,47 +1501,48 @@ class Rectangle(Record): """ Rectangle record (ID 20) - Properties: - .is_square (bool, True if this is a square. - If True, height must be None.) - .width (int or None, None means reuse modal) - .height (int or None, Must be None if .is_square is True. - If .is_square is False, None means reuse modal) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means use modal) - .y (int or None, None means use modal) - .repetition (reptetition or None) + Attributes: + is_square (bool): `True` if this is a square. + If `True`, `height` must be `None`. + width (Optional[int]): `None` means reuse modal. + height (Optional[int]): Must be `None` if `is_square` is `True`. + If `is_square` is `False`, `None` means reuse modal. + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - layer = None # type: int or None - datatype = None # type: int or None - width = None # type: int or None - height = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None - is_square = None # type: bool + layer: Optional[int] = None + datatype: Optional[int] = None + width: Optional[int] = None + height: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None + is_square: bool = False def __init__(self, is_square: bool = False, - layer: int = None, - datatype: int = None, - width: int = None, - height: int = None, - x: int = None, - y: int = None, - repetition: repetition_t = None): + layer: Optional[int] = None, + datatype: Optional[int] = None, + width: Optional[int] = None, + height: Optional[int] = None, + x: Optional[int] = None, + y: Optional[int] = None, + repetition: Optional[repetition_t] = None): """ - :param is_square: True if this is a square. If True, height must - be None. Default False. - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param width: X-width. Default None (reuse modal). - :param height: Y-height. Default None (reuse modal, or use width if - square). Must be None if is_square is True. - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). + Args: + is_square: `True` if this is a square. If `True`, `height` must + be `None`. Default `False`. + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + width: X-width. Default `None` (reuse modal). + height: Y-height. Default `None` (reuse modal, or use `width` if + square). Must be `None` if `is_square` is `True`. + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). """ self.is_square = is_square self.layer = layer @@ -1589,40 +1636,40 @@ class Polygon(Record): """ Polygon record (ID 21) - Properties: - .point_list ([[x0, y0], [x1, y1], ...] or None, - list is an implicitly closed path, - vertices are [int, int], - None means reuse modal) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means reuse modal) - .y (int or None, None means reuse modal) - .repetition (reptetition or None) + Attributes: + point_list (Optional[point_list_t]): `[[x0, y0], [x1, y1], ...]` + The list is an implicitly closed path, vertices are [int, int], + `None` means reuse modal. + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - layer = None # type: int or None - datatype = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None - point_list = None # type: List[List[int]] or None + layer: Optional[int] = None + datatype: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None + point_list: Optional[point_list_t] = None def __init__(self, - point_list: List[List[int]] = None, - layer: int = None, - datatype: int = None, - x: int = None, - y: int = None, - repetition: repetition_t = None): + point_list: Optional[point_list_t] = None, + layer: Optional[int] = None, + datatype: Optional[int] = None, + x: Optional[int] = None, + y: Optional[int] = None, + repetition: Optional[repetition_t] = None): """ - :param point_list: List of vertices [[x0, y0], [x1, y1], ...]. - List forms an implicitly closed path - Default None (reuse modal). - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). + Args: + point_list: List of vertices `[[x0, y0], [x1, y1], ...]`. + List forms an implicitly closed path. + Default `None` (reuse modal). + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). """ self.layer = layer self.datatype = datatype @@ -1705,63 +1752,60 @@ class Path(Record): """ Polygon record (ID 22) - Properties: - .point_list ([[x0, y0], [x1, y1], ...] or None, - vertices are [int, int], - None means reuse modal) - .half_width (int or None, None means reuse modal) - .extension_start (Tuple or None, - None means reuse modal, - Tuple is of the form - (PathExtensionScheme, int or None) - second value is None unless using - PathExtensionScheme.Arbitrary - Value determines extension past start point. - .extension_end Same form as extension_end. Value determines - extension past end point. - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means use modal) - .y (int or None, None means use modal) - .repetition (reptetition or None) + Attributes: + point_list (Optional[point_list_t]): `[[x0, y0], [x1, y1], ...]` + Vertices are [int, int]; `None` means reuse modal. + half_width (Optional[int]): None means reuse modal + extension_start (Optional[Tuple]): None means reuse modal. + Tuple is of the form (`PathExtensionScheme`, Optional[int]) + Second value is None unless using `PathExtensionScheme.Arbitrary` + Value determines extension past start point. + extension_end (Optional[Tuple]): Same form as `extension_end`. + Value determines extension past end point. + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - layer = None # type: int or None - datatype = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None - point_list = None # type: List[List[int]] or None - half_width = None # type: int or None - extension_start = None # type: pathextension_t or None - extension_end = None # type: pathextension_t or None + layer: Optional[int] = None + datatype: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None + point_list: Optional[point_list_t] = None + half_width: Optional[int] = None + extension_start: Optional[pathextension_t] = None + extension_end: Optional[pathextension_t] = None def __init__(self, - point_list: List[List[int]] = None, - half_width: int = None, - extension_start: pathextension_t = None, - extension_end: pathextension_t = None, - layer: int = None, - datatype: int = None, - x: int = None, - y: int = None, - repetition: repetition_t = None): + point_list: Optional[point_list_t] = None, + half_width: Optional[int] = None, + extension_start: Optional[pathextension_t] = None, + extension_end: Optional[pathextension_t] = None, + layer: Optional[int] = None, + datatype: Optional[int] = None, + x: Optional[int] = None, + y: Optional[int] = None, + repetition: Optional[repetition_t] = None): """ - :param point_list: List of vertices [[x0, y0], [x1, y1], ...]. - Default None (reuse modal). - :param half_width: Half-width of the path. Default None (reuse modal). - :param extension_start: Specification for path extension at start of path. - None or Tuple: (PathExtensionScheme, int or None). - int is used only for PathExtensionScheme.Arbitrary. - Default None (reuse modal). - :param extension_end: Specification for path extension at end of path. - None or Tuple: (PathExtensionScheme, int or None). - int is used only for PathExtensionScheme.Arbitrary. - Default None (reuse modal). - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). + Args: + point_list: List of vertices `[[x0, y0], [x1, y1], ...]`. + Default `None` (reuse modal). + half_width: Half-width of the path. Default `None` (reuse modal). + extension_start: Specification for path extension at start of path. + `None` or `Tuple`: `(PathExtensionScheme, int or None)`. + int is used only for `PathExtensionScheme.Arbitrary`. + Default `None` (reuse modal). + extension_end: Specification for path extension at end of path. + `None` or `Tuple`: `(PathExtensionScheme, int or None)`. + int is used only for `PathExtensionScheme.Arbitrary`. + Default `None` (reuse modal). + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). """ self.layer = layer self.datatype = datatype @@ -1880,39 +1924,36 @@ class Trapezoid(Record): """ Trapezoid record (ID 23, 24, 25) - Properties: - .delta_a (int or None, - If horizontal, signed x-distance from top left - vertex to bottom left vertex. If vertical, signed - y-distance from bottom left vertex to bottom right - vertex. - None means reuse modal.) - .delta_b (int or None, - If horizontal, signed x-distance from bottom right - vertex to top right vertex. If vertical, signed - y-distance from top right vertex to top left vertex. - None means reuse modal.) - .is_vertical (bool, True if the left and right sides are aligned to - the y-axis. If the trapezoid is a rectangle, either - True or False can be used.) - .width (int or None, Bounding box x-width, None means reuse modal) - .height (int or None, Bounding box y-height, None means reuse modal) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means se modal) - .y (int or None, None means se modal) - .repetition (reptetition or None) + Attributes: + delta_a (Optional[int]): If horizontal, signed x-distance from top left + vertex to bottom left vertex. If vertical, signed y-distance from + bottom left vertex to bottom right vertex. + None means reuse modal. + delta_b (Optional[int]): If horizontal, signed x-distance from bottom right + vertex to top right vertex. If vertical, signed y-distance from top + right vertex to top left vertex. + None means reuse modal. + is_vertical (bool): `True` if the left and right sides are aligned to + the y-axis. If the trapezoid is a rectangle, either `True` or `False` + can be used. + width (Optional[int]): Bounding box x-width, None means reuse modal. + height (Optional[int]): Bounding box y-height, None means reuse modal. + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - layer = None # type: int or None - datatype = None # type: int or None - width = None # type: int or None - height = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None - delta_a = None # type: int - delta_b = None # type: int - is_vertical = None # type: bool + layer: Optional[int] = None + datatype: Optional[int] = None + width: Optional[int] = None + height: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None + delta_a: int = 0 + delta_b: int = 0 + is_vertical: bool def __init__(self, is_vertical: bool, @@ -1926,23 +1967,28 @@ class Trapezoid(Record): y: int = None, repetition: repetition_t = None): """ - :param is_vertical: True if both the left and right sides are aligned - to the y-axis. If the trapezoid is a rectangle, either value - is permitted. - :param delta_a: If horizontal, signed x-distance from top-left vertex - to bottom-left vertex. If vertical, signed y-distance from bottom- - left vertex to bottom-right vertex. Default None (reuse modal). - :param delta_b: If horizontal, signed x-distance from bottom-right vertex - to top right vertex. If vertical, signed y-distance from top-right - vertex to top-left vertex. Default None (reuse modal). - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param width: X-width of bounding box. Default None (reuse modal). - :param height: Y-height of bounding box. Default None (reuse modal) - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). - :raises: InvalidDataError if dimensions are impossible. + Args: + is_vertical: `True` if both the left and right sides are aligned + to the y-axis. If the trapezoid is a rectangle, either value + is permitted. + delta_a: If horizontal, signed x-distance from top-left vertex + to bottom-left vertex. If vertical, signed y-distance from bottom- + left vertex to bottom-right vertex. + Default `None` (reuse modal). + delta_b: If horizontal, signed x-distance from bottom-right vertex + to top right vertex. If vertical, signed y-distance from top-right + vertex to top-left vertex. + Default `None` (reuse modal). + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + width: X-width of bounding box. Default `None` (reuse modal). + height: Y-height of bounding box. Default `None` (reuse modal) + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). + + Raises: + InvalidDataError: if dimensions are impossible. """ self.is_vertical = is_vertical self.delta_a = delta_a @@ -2054,24 +2100,24 @@ class CTrapezoid(Record): """ CTrapezoid record (ID 26) - Properties: - .ctrapezoid_type (int or None, see OASIS spec for details, None means reuse modal) - .width (int or None, Bounding box x-width, None means reuse modal) - .height (int or None, Bounding box y-height, None means reuse modal) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means se modal) - .y (int or None, None means se modal) - .repetition (reptetition or None) + Attributes: + ctrapezoid_type (Optional[int]): see OASIS spec for details, None means reuse modal. + width (Optional[int]): Bounding box x-width, None means reuse modal. + height (Optional[int]): Bounding box y-height, None means reuse modal. + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - ctrapezoid_type = None # type: int or None - layer = None # type: int or None - datatype = None # type: int or None - width = None # type: int or None - height = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None + ctrapezoid_type: Optional[int] = None + layer: Optional[int] = None + datatype: Optional[int] = None + width: Optional[int] = None + height: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None def __init__(self, ctrapezoid_type: int = None, @@ -2083,16 +2129,19 @@ class CTrapezoid(Record): y: int = None, repetition: repetition_t = None): """ - :param ctrapezoid_type: CTrapezoid type; see OASIS format - documentation. Default None (reuse modal). - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param width: X-width of bounding box. Default None (reuse modal). - :param height: Y-height of bounding box. Default None (reuse modal) - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). - :raises: InvalidDataError if dimensions are invalid. + Args: + ctrapezoid_type: CTrapezoid type; see OASIS format + documentation. Default `None` (reuse modal). + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + width: X-width of bounding box. Default `None` (reuse modal). + height: Y-height of bounding box. Default `None` (reuse modal) + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). + + Raises: + InvalidDataError: if dimensions are invalid. """ self.ctrapezoid_type = ctrapezoid_type self.layer = layer @@ -2232,20 +2281,20 @@ class Circle(Record): """ Circle record (ID 27) - Properties: - .radius (int or None, None means reuse modal) - .layer (int or None, None means reuse modal) - .datatype (int or None, None means reuse modal) - .x (int or None, None means se modal) - .y (int or None, None means se modal) - .repetition (reptetition or None) + Attributes: + radius (Optional[int]): None means reuse modal + layer (Optional[int]): None means reuse modal + datatype (Optional[int]): None means reuse modal + x (Optional[int]): x-offset, None means reuse modal + y (Optional[int]): y-offset, None means reuse modal + repetition (Optional[repetition_t]): Repetition, if any """ - layer = None # type: int or None - datatype = None # type: int or None - x = None # type: int or None - y = None # type: int or None - repetition = None # type: repetition_t or None - radius = None # type: int or None + layer: Optional[int] = None + datatype: Optional[int] = None + x: Optional[int] = None + y: Optional[int] = None + repetition: Optional[repetition_t] = None + radius: Optional[int] = None def __init__(self, radius: int = None, @@ -2255,13 +2304,16 @@ class Circle(Record): y: int = None, repetition: repetition_t = None): """ - :param radius: Radius. Default None (reuse modal). - :param layer: Layer number. Default None (reuse modal). - :param datatype: Datatype number. Default None (reuse modal). - :param x: X-offset. Default None (use modal). - :param y: Y-offset. Default None (use modal). - :param repetition: Repetition. Default None (no repetition). - :raises: InvalidDataError if dimensions are invalid. + Args: + radius: Radius. Default `None` (reuse modal). + layer: Layer number. Default `None` (reuse modal). + datatype: Datatype number. Default `None` (reuse modal). + x: X-offset. Default `None` (use modal). + y: Y-offset. Default `None` (use modal). + repetition: Repetition. Default `None` (no repetition). + + Raises: + InvalidDataError: if dimensions are invalid. """ self.radius = radius self.layer = layer @@ -2340,10 +2392,13 @@ def adjust_repetition(record: Record, modals: Modals): """ Merge the record's repetition entry with the one in the modals - :param record: Record to read or modify. - :param modals: Modals to read or modify. - :raises: InvalidDataError if a ReuseRepetition can't be filled - from the modals. + Args: + record: Record to read or modify. + modals: Modals to read or modify. + + Raises: + InvalidDataError: if a `ReuseRepetition` can't be filled + from the modals. """ if record.repetition is not None: if isinstance(record.repetition, ReuseRepetition): @@ -2357,13 +2412,16 @@ def adjust_repetition(record: Record, modals: Modals): def adjust_field(record: Record, r_field: str, modals: Modals, m_field: str): """ - Merge record.r_field with modals.m_field + Merge `record.r_field` with `modals.m_field` - :param record: Record to read or modify. - :param r_field: Attr of record to access. - :param modals: Modals to read or modify. - :param m_field: Attr of modals to access. - :raises: InvalidDataError if a both fields are None + Args: + record: `Record` to read or modify. + r_field: Attr of record to access. + modals: `Modals` to read or modify. + m_field: Attr of modals to access. + + Raises: + InvalidDataError: if both fields are `None` """ r = getattr(record, r_field) if r is not None: @@ -2378,18 +2436,21 @@ def adjust_field(record: Record, r_field: str, modals: Modals, m_field: str): def adjust_coordinates(record: Record, modals: Modals, mx_field: str, my_field: str): """ - Merge record.x and record.y with modals.mx_field and modals.my_field, - taking into account the value of modals.xy_relative. + Merge `record.x` and `record.y` with `modals.mx_field` and `modals.my_field`, + taking into account the value of `modals.xy_relative`. - If modals.xy_relative is True and the record has non-None coordinates, - the modal values are added to the record's coordinates. If modals.xy_relative - is False, the coordinates are treated the same way as other fields. + If `modals.xy_relative` is `True` and the record has non-`None` coordinates, + the modal values are added to the record's coordinates. If `modals.xy_relative` + is `False`, the coordinates are treated the same way as other fields. - :param record: Record to read or modify. - :param modals: Modals to read or modify. - :param mx_field: Attr of modals corresponding to record.x - :param my_field: Attr of modals corresponding to record.y - :raises: InvalidDataError if a both fields are None + Args: + record: `Record` to read or modify. + modals: `Modals` to read or modify. + mx_field: Attr of modals corresponding to `record.x` + my_field: Attr of modals corresponding to `record.y` + + Raises: + InvalidDataError: if both fields are `None` """ if record.x is not None: if modals.xy_relative: @@ -2414,10 +2475,13 @@ def dedup_repetition(record: Record, modals: Modals): Deduplicate the record's repetition entry with the one in the modals. Update the one in the modals if they are different. - :param record: Record to read or modify. - :param modals: Modals to read or modify. - :raises: InvalidDataError if a ReuseRepetition can't be filled - from the modals. + Args: + record: `Record` to read or modify. + modals: `Modals` to read or modify. + + Raises: + InvalidDataError: if a `ReuseRepetition` can't be filled + from the modals. """ if record.repetition is None: return @@ -2435,14 +2499,17 @@ def dedup_repetition(record: Record, modals: Modals): def dedup_field(record: Record, r_field: str, modals: Modals, m_field: str): """ - Deduplicate record.r_field using modals.m_field - Update the modals.m_field if they are different. + Deduplicate `record.r_field` using `modals.m_field` + Update the `modals.m_field` if they are different. - :param record: Record to read or modify. - :param r_field: Attr of record to access. - :param modals: Modals to read or modify. - :param m_field: Attr of modals to access. - :raises: InvalidDataError if a both fields are None + Args: + record: `Record` to read or modify. + r_field: Attr of record to access. + modals: `Modals` to read or modify. + m_field: Attr of modals to access. + + Args: + InvalidDataError: if both fields are `None` """ r = getattr(record, r_field) m = getattr(modals, m_field) @@ -2462,18 +2529,21 @@ def dedup_field(record: Record, r_field: str, modals: Modals, m_field: str): def dedup_coordinates(record: Record, modals: Modals, mx_field: str, my_field: str): """ - Deduplicate record.x and record.y using modals.mx_field and modals.my_field, - taking into account the value of modals.xy_relative. + Deduplicate `record.x` and `record.y` using `modals.mx_field` and `modals.my_field`, + taking into account the value of `modals.xy_relative`. - If modals.xy_relative is True and the record has non-None coordinates, - the modal values are subtracted from the record's coordinates. If modals.xy_relative - is False, the coordinates are treated the same way as other fields. + If `modals.xy_relative` is `True` and the record has non-`None` coordinates, + the modal values are subtracted from the record's coordinates. If `modals.xy_relative` + is `False`, the coordinates are treated the same way as other fields. - :param record: Record to read or modify. - :param modals: Modals to read or modify. - :param mx_field: Attr of modals corresponding to record.x - :param my_field: Attr of modals corresponding to record.y - :raises: InvalidDataError if a both fields are None + Args: + record: `Record` to read or modify. + modals: `Modals` to read or modify. + mx_field: Attr of modals corresponding to `record.x` + my_field: Attr of modals corresponding to `record.y` + + Raises: + InvalidDataError: if both fields are `None` """ if record.x is not None: mx = getattr(modals, mx_field)