cfinterface 1.5.2__tar.gz → 1.7.0__tar.gz

{cfinterface-1.5.2 → cfinterface-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cfinterface
-Version: 1.5.2
+Version: 1.7.0
 Summary: Interface for handling custom formatted files
 Home-page: https://github.com/rjmalves/cfi
 Author: Rogerio Alves
@@ -12,6 +12,8 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Dist: numpy
+Requires-Dist: pandas
 
 # cfinterface
 

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/__init__.py

@@ -6,7 +6,7 @@ cfi is a Python module for handling custom formatted files
 and provide reading, storing and writing utilities.
 """
 
-__version__ = "1.5.2"
+__version__ = "1.7.0"
 
 from . import components  # noqa
 from . import data  # noqa

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/adapters/reading/repository.py

@@ -4,6 +4,9 @@ from io import BytesIO, StringIO
 
 
 class Repository(ABC):
+
+    __slots__ = ["_content", "_wrap_io"]
+
     def __init__(
         self, content: Union[str, bytes], wrap_io: bool = False, *args
     ) -> None:
@@ -36,6 +39,9 @@ class Repository(ABC):
 
 
 class BinaryRepository(Repository):
+
+    __slots__ = ["_filepointer"]
+
     def __init__(
         self, content: Union[str, bytes], wrap_io: bool = False, *args
     ) -> None:
@@ -72,6 +78,9 @@ class BinaryRepository(Repository):
 
 
 class TextualRepository(Repository):
+
+    __slots__ = ["_filepointer", "_encoding"]
+
     def __init__(
         self,
         content: str,

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/adapters/writing/repository.py

@@ -3,6 +3,9 @@ from abc import ABC, abstractmethod
 
 
 class Repository(ABC):
+
+    __slots__ = ["_to", "_wrap_io"]
+
     def __init__(self, to: Union[str, IO], *args) -> None:
         self._to = to
         self._wrap_io = isinstance(to, str)
@@ -30,6 +33,9 @@ class Repository(ABC):
 
 
 class BinaryRepository(Repository):
+
+    __slots__ = ["_filepointer"]
+
     def __init__(self, path: str, *args) -> None:
         super().__init__(path)
         self._filepointer: BinaryIO = None  # type: ignore
@@ -59,6 +65,9 @@ class BinaryRepository(Repository):
 
 
 class TextualRepository(Repository):
+
+    __slots__ = ["_filepointer", "_encoding"]
+
     def __init__(self, path: str, encoding: str) -> None:
         super().__init__(path)
         self._filepointer: TextIO = None  # type: ignore

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/block.py

@@ -9,6 +9,8 @@ class Block:
     for beginning and end and reading states.
     """
 
+    __slots__ = ["__previous", "__next", "__data"]
+
     BEGIN_PATTERN: Union[str, bytes] = ""
     END_PATTERN: Union[str, bytes] = ""
     MAX_LINES = 10000

cfinterface-1.7.0/cfinterface/components/datetimefield.py

@@ -0,0 +1,96 @@
+from datetime import datetime
+import pandas as pd  # type: ignore
+from typing import Optional, Union, List
+
+from cfinterface.components.field import Field
+
+
+class DatetimeField(Field):
+    """
+    Class for representing an datetime field for being read from and
+    written to a file. The format to read and write the value is given
+    by an optional argument.
+    """
+
+    __slots__ = ["__format"]
+
+    def __init__(
+        self,
+        size: int = 16,
+        starting_position: int = 0,
+        format: Union[str, List[str]] = "%Y/%m/%d",
+        value: Optional[datetime] = None,
+    ) -> None:
+        super().__init__(size, starting_position, value)
+        self.__format = format
+
+    # Override
+    def _binary_read(self, line: bytes) -> datetime:
+        formats = (
+            [self.__format]
+            if isinstance(self.__format, str)
+            else self.__format
+        )
+        for fmt in formats:
+            try:
+                return datetime.strptime(
+                    line[self._starting_position : self._ending_position]
+                    .decode("utf-8")
+                    .strip(),
+                    fmt,
+                )
+            except ValueError:
+                pass
+        raise ValueError("Could not read datetime")
+
+    # Override
+    def _textual_read(self, line: str) -> datetime:
+        formats = (
+            [self.__format]
+            if isinstance(self.__format, str)
+            else self.__format
+        )
+        for fmt in formats:
+            try:
+                return datetime.strptime(
+                    line[
+                        self._starting_position : self._ending_position
+                    ].strip(),
+                    fmt,
+                )
+            except ValueError:
+                pass
+        raise ValueError("Could not read datetime")
+
+    # Override
+    def _binary_write(self) -> bytes:
+        if self.value is None or pd.isnull(self.value):
+            return b"".ljust(self.size)
+        else:
+            format = (
+                self.__format
+                if isinstance(self.__format, str)
+                else self.__format[0]
+            )
+            return self.value.strftime(format).ljust(self.size).encode("utf-8")
+
+    # Override
+    def _textual_write(self) -> str:
+        if self.value is None or pd.isnull(self.value):
+            value = ""
+        else:
+            format = (
+                self.__format
+                if isinstance(self.__format, str)
+                else self.__format[0]
+            )
+            value = self.value.strftime(format)
+        return value.ljust(self._size)
+
+    @property
+    def value(self) -> Optional[datetime]:
+        return self._value
+
+    @value.setter
+    def value(self, val: datetime):
+        self._value = val

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/defaultblock.py

@@ -8,6 +8,8 @@ class DefaultBlock(Block):
     the data from the read line. Mainly used for comments.
     """
 
+    __slots__ = []
+
     def __eq__(self, o: object) -> bool:
         if not isinstance(o, DefaultBlock):
             return False

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/defaultregister.py

@@ -8,6 +8,8 @@ class DefaultRegister(Register):
     the data from the read line. Mainly used for comments.
     """
 
+    __slots__ = []
+
     def __init__(self, previous=None, next=None, data=None) -> None:
         super().__init__(previous, next, data)
 

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/defaultsection.py

@@ -8,6 +8,8 @@ class DefaultSection(Section):
     and is used for representing empty data.
     """
 
+    __slots__ = []
+
     def __eq__(self, o: object) -> bool:
         if not isinstance(o, DefaultSection):
             return False

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/field.py

@@ -8,6 +8,8 @@ class Field:
     in a file.
     """
 
+    __slots__ = ["_size", "_starting_position", "_ending_position", "_value"]
+
     T = TypeVar("T", str, bytes)
 
     def __init__(

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/floatfield.py

@@ -12,6 +12,8 @@ class FloatField(Field):
     by 'F' for fixed point notation and 'E' for scientific notation.
     """
 
+    __slots__ = ["__decimal_digits", "__format", "__sep", "__type"]
+
     TYPES = {
         2: np.float16,
         4: np.float32,

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/integerfield.py

@@ -12,6 +12,8 @@ class IntegerField(Field):
     written to a file.
     """
 
+    __slots__ = ["__type"]
+
     TYPES = {
         2: np.int16,
         4: np.int32,

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/line.py

@@ -13,6 +13,15 @@ class Line:
     of fields and can be read from or written to a file.
     """
 
+    __slots__ = [
+        "_delimiter",
+        "_fields",
+        "_values",
+        "_storage",
+        "_repository",
+        "_size",
+    ]
+
     def __init__(
         self,
         fields: List[Field],

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/literalfield.py

@@ -9,6 +9,8 @@ class LiteralField(Field):
     written to a file.
     """
 
+    __slots__ = []
+
     def __init__(
         self,
         size: int = 80,

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/register.py

@@ -14,6 +14,8 @@ class Register:
     which is located at the beginning of the line.
     """
 
+    __slots__ = ["__previous", "__next", "__data", "__identifier_field"]
+
     IDENTIFIER: Union[str, bytes] = ""
     IDENTIFIER_DIGITS = 0
     LINE = Line([])

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/components/section.py

@@ -7,6 +7,8 @@ class Section:
     a given order
     """
 
+    __slots__ = ["__previous", "__next", "__data"]
+
     STORAGE: str = "TEXT"
 
     def __init__(

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/data/blockdata.py

@@ -8,6 +8,8 @@ class BlockData:
     Class for a storing, managing and accessing data for a block file.
     """
 
+    __slots__ = ["__root", "__head"]
+
     T = TypeVar("T")
 
     def __init__(self, root: Block) -> None:
@@ -148,6 +150,22 @@ class BlockData:
         else:
             return filtered_blocks
 
+    def remove_blocks_of_type(self, t: Type[T], **kwargs):
+        """
+        Removes a set of blocks given a type and an optional group of
+        filters, similar to `get_blocks_of_type()`
+
+        :param t: The block type that is desired
+        :type t: Type[T]
+        """
+        filtered_blocks = self.get_blocks_of_type(t, **kwargs)
+        if isinstance(filtered_blocks, Block):
+            self.remove(filtered_blocks)
+        elif isinstance(filtered_blocks, list):
+            for b in filtered_blocks:
+                if isinstance(b, Block) and b != self.__root:
+                    self.remove(b)
+
     @property
     def first(self) -> Block:
         return self.__root

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/data/registerdata.py

@@ -8,6 +8,8 @@ class RegisterData:
     Class for a storing, managing and accessing data for a register file.
     """
 
+    __slots__ = ["__root", "__head"]
+
     T = TypeVar("T")
 
     def __init__(self, root: Register) -> None:
@@ -147,6 +149,24 @@ class RegisterData:
         else:
             return filtered_registers
 
+    def remove_registers_of_type(self, t: Type[T], **kwargs):
+        """
+        Removes a set of registers given a type and an optional group of
+        filters, similar to `get_registers_of_type()`
+
+        :param t: The register type that is desired
+        :type t: Type[T]
+        """
+        filtered_registers = self.get_registers_of_type(t, **kwargs)
+        if isinstance(filtered_registers, t) and isinstance(
+            filtered_registers, Register
+        ):
+            self.remove(filtered_registers)
+        elif isinstance(filtered_registers, list):
+            for r in filtered_registers:
+                if isinstance(r, Register) and r != self.__root:
+                    self.remove(r)
+
     @property
     def first(self) -> Register:
         return self.__root

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/data/sectiondata.py

@@ -8,6 +8,8 @@ class SectionData:
     Class for a storing, managing and accessing data for a section file.
     """
 
+    __slots__ = ["__root", "__head"]
+
     T = TypeVar("T")
 
     def __init__(self, root: Section) -> None:
@@ -148,6 +150,24 @@ class SectionData:
         else:
             return filtered_sections
 
+    def remove_sections_of_type(self, t: Type[T], **kwargs):
+        """
+        Removes a set of sections given a type and an optional group of
+        filters, similar to `get_sections_of_type()`
+
+        :param t: The section type that is desired
+        :type t: Type[T]
+        """
+        filtered_sections = self.get_sections_of_type(t, **kwargs)
+        if isinstance(filtered_sections, t) and isinstance(
+            filtered_sections, Section
+        ):
+            self.remove(filtered_sections)
+        elif isinstance(filtered_sections, list):
+            for s in filtered_sections:
+                if isinstance(s, Section) and s != self.__root:
+                    self.remove(s)
+
     @property
     def first(self) -> Section:
         return self.__root

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/files/blockfile.py

@@ -13,6 +13,8 @@ class BlockFile:
     and writing are given by a series of blocks.
     """
 
+    __slots__ = ["__data", "__storage", "__encoding"]
+
     VERSIONS: Dict[str, List[Type[Block]]] = {}
     BLOCKS: List[Type[Block]] = []
     ENCODING = "utf-8"

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/files/registerfile.py

@@ -13,6 +13,8 @@ class RegisterFile:
     and writing are given by a series of registers.
     """
 
+    __slots__ = ["__data", "__storage", "__encoding"]
+
     VERSIONS: Dict[str, List[Type[Register]]] = {}
     REGISTERS: List[Type[Register]] = []
     ENCODING = "utf-8"

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/files/sectionfile.py

@@ -13,6 +13,8 @@ class SectionFile:
     and writing are given by a series of registers.
     """
 
+    __slots__ = ["__data", "__storage", "__encoding"]
+
     VERSIONS: Dict[str, List[Type[Section]]] = {}
     SECTIONS: List[Type[Section]] = []
     ENCODING = "utf-8"

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/reading/blockreading.py

@@ -13,6 +13,15 @@ class BlockReading:
     Class for reading custom files based on a BlockData structure.
     """
 
+    __slots__ = [
+        "__allowed_blocks",
+        "__data",
+        "__last_position_filepointer",
+        "__storage",
+        "__linesize",
+        "__repository",
+    ]
+
     def __init__(
         self,
         allowed_blocks: List[Type[Block]],

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/reading/registerreading.py

@@ -13,6 +13,15 @@ class RegisterReading:
     Class for reading custom files based on a RegisterData structure.
     """
 
+    __slots__ = [
+        "__allowed_registers",
+        "__data",
+        "__last_position_filepointer",
+        "__storage",
+        "__linesize",
+        "__repository",
+    ]
+
     def __init__(
         self,
         allowed_registers: List[Type[Register]],

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/reading/sectionreading.py

@@ -13,6 +13,15 @@ class SectionReading:
     Class for reading custom files based on a SectionData structure.
     """
 
+    __slots__ = [
+        "__sections",
+        "__data",
+        "__last_position_filepointer",
+        "__storage",
+        "__linesize",
+        "__repository",
+    ]
+
     def __init__(
         self,
         sections: List[Type[Section]],

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/writing/blockwriting.py

@@ -11,6 +11,12 @@ class BlockWriting:
     Class for writing custom files based on a BlockData structure.
     """
 
+    __slots__ = [
+        "__data",
+        "__storage",
+        "__repository",
+    ]
+
     def __init__(self, data: BlockData, storage: str = "") -> None:
         self.__data = data
         self.__storage = storage

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/writing/registerwriting.py

@@ -12,6 +12,12 @@ class RegisterWriting:
     Class for writing custom files based on a RegisterData structure.
     """
 
+    __slots__ = [
+        "__data",
+        "__storage",
+        "__repository",
+    ]
+
     def __init__(self, data: RegisterData, storage: str = "") -> None:
         self.__data = data
         self.__storage = storage

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface/writing/sectionwriting.py

@@ -12,6 +12,12 @@ class SectionWriting:
     Class for writing custom files based on a SectionData structure.
     """
 
+    __slots__ = [
+        "__data",
+        "__storage",
+        "__repository",
+    ]
+
     def __init__(self, data: SectionData, storage: str = "") -> None:
         self.__data = data
         self.__storage = storage

{cfinterface-1.5.2 → cfinterface-1.7.0}/cfinterface.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cfinterface
-Version: 1.5.2
+Version: 1.7.0
 Summary: Interface for handling custom formatted files
 Home-page: https://github.com/rjmalves/cfi
 Author: Rogerio Alves
@@ -12,6 +12,8 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
+Requires-Dist: numpy
+Requires-Dist: pandas
 
 # cfinterface
 

{cfinterface-1.5.2 → cfinterface-1.7.0}/tests/components/test_datetimefield.py

@@ -21,6 +21,15 @@ def test_datetimefield_read():
     assert field.value == datetime.strptime(data, format)
 
 
+def test_datetimefield_read_format_list():
+    data = "2020/01/10"
+    formats = ["%Y-%m-%d", "%Y/%m/%d"]
+    field = DatetimeField(10, 0, format=formats)
+    line = f"{data}-something-else"
+    field.read(line)
+    assert field.value == datetime.strptime(data, formats[1])
+
+
 def test_datetimefield_write():
     data = "2020/01/10"
     format = "%Y/%m/%d"
@@ -31,6 +40,16 @@ def test_datetimefield_write():
     assert line_before == line_after
 
 
+def test_datetimefield_write_format_list():
+    data = "2020/01/10"
+    formats = ["%Y-%m-%d", "%Y/%m/%d"]
+    line_before = f"field-{data}-else"
+    date_data = datetime.strptime(data, formats[1])
+    field = DatetimeField(10, 6, format=formats, value=date_data)
+    line_after = field.write(line_before)
+    assert line_before.replace("/", "-") == line_after
+
+
 def test_datetimefield_write_empty():
     field = DatetimeField(5, 0)
     assert len(field.write("")) == 5

{cfinterface-1.5.2 → cfinterface-1.7.0}/tests/data/test_blockdata.py

@@ -125,3 +125,12 @@ def test_blockdata_get_blocks_of_type_filter():
     bd.append(DummyBlock(data=11))
     assert len(bd.get_blocks_of_type(DummyBlock)) == 3
     assert bd.get_blocks_of_type(DummyBlock, my_data=10) == b1
+
+
+def test_blockdata_remove_blocks_of_type_no_filter():
+    b1 = DummyBlock(data=10)
+    bd = BlockData(b1)
+    bd.append(DummyBlock())
+    bd.append(DummyBlock(data=11))
+    bd.remove_blocks_of_type(DummyBlock)
+    assert len(bd) == 1

{cfinterface-1.5.2 → cfinterface-1.7.0}/tests/data/test_registerdata.py

@@ -108,17 +108,26 @@ def test_registerdata_of_type():
     assert len([b for b in rd.of_type(DummyRegister)]) == 2
 
 
-def test_RegisterData_get_registers_of_type_no_filter():
+def test_registerdata_get_registers_of_type_no_filter():
     r1 = DummyRegister(data=[10])
     rd = RegisterData(r1)
     rd.append(Register())
     assert rd.get_registers_of_type(DummyRegister) == r1
 
 
-def test_RegisterData_get_registers_of_type_filter():
+def test_registerdata_get_registers_of_type_filter():
     r1 = DummyRegister(data=[10])
     rd = RegisterData(r1)
     rd.append(DummyRegister())
     rd.append(DummyRegister(data=[11]))
     assert len(rd.get_registers_of_type(DummyRegister)) == 3
     assert rd.get_registers_of_type(DummyRegister, my_data=10) == r1
+
+
+def test_registerdata_remove_registers_of_type_no_filter():
+    r1 = DummyRegister(data=[10])
+    rd = RegisterData(r1)
+    rd.append(DummyRegister())
+    rd.append(DummyRegister(data=[11]))
+    rd.remove_registers_of_type(DummyRegister)
+    assert len(rd) == 1

{cfinterface-1.5.2 → cfinterface-1.7.0}/tests/data/test_sectiondata.py

@@ -122,3 +122,12 @@ def test_sectiondata_get_sections_of_type_filter():
     bd.append(DummySection(data=11))
     assert len(bd.get_sections_of_type(DummySection)) == 3
     assert bd.get_sections_of_type(DummySection, my_data=10) == b1
+
+
+def test_sectiondata_remove_sections_of_type_no_filter():
+    b1 = DummySection(data=10)
+    bd = SectionData(b1)
+    bd.append(DummySection())
+    bd.append(DummySection(data=11))
+    bd.remove_sections_of_type(DummySection)
+    assert len(bd) == 1

cfinterface-1.5.2/cfinterface/components/datetimefield.py

@@ -1,66 +0,0 @@
-from datetime import datetime
-import pandas as pd  # type: ignore
-from typing import Optional
-
-from cfinterface.components.field import Field
-
-
-class DatetimeField(Field):
-    """
-    Class for representing an datetime field for being read from and
-    written to a file. The format to read and write the value is given
-    by an optional argument.
-    """
-
-    def __init__(
-        self,
-        size: int = 16,
-        starting_position: int = 0,
-        format: str = "%Y/%m/%d",
-        value: Optional[datetime] = None,
-    ) -> None:
-        super().__init__(size, starting_position, value)
-        self.__format = format
-
-    # Override
-    def _binary_read(self, line: bytes) -> datetime:
-        return datetime.strptime(
-            line[self._starting_position : self._ending_position]
-            .decode("utf-8")
-            .strip(),
-            self.__format,
-        )
-
-    # Override
-    def _textual_read(self, line: str) -> datetime:
-        return datetime.strptime(
-            line[self._starting_position : self._ending_position].strip(),
-            self.__format,
-        )
-
-    # Override
-    def _binary_write(self) -> bytes:
-        if self.value is None or pd.isnull(self.value):
-            return b"".ljust(self.size)
-        else:
-            return (
-                self.value.strftime(self.__format)
-                .ljust(self.size)
-                .encode("utf-8")
-            )
-
-    # Override
-    def _textual_write(self) -> str:
-        if self.value is None or pd.isnull(self.value):
-            value = ""
-        else:
-            value = self.value.strftime(self.__format)
-        return value.ljust(self._size)
-
-    @property
-    def value(self) -> Optional[datetime]:
-        return self._value
-
-    @value.setter
-    def value(self, val: datetime):
-        self._value = val