3.10 adjustment: Optional and Union

Author: tammoippen

pydifact/parser.py

@@ -20,7 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 from collections.abc import Iterator
-from typing import Optional, Union
 
 from pydifact.tokenizer import Tokenizer
 from pydifact.token import Token
@@ -33,14 +32,14 @@ class Parser:
 
     def __init__(
         self,
-        factory: Optional[SegmentFactory] = None,
-        characters: Optional[Characters] = None,
+        factory: SegmentFactory | None = None,
+        characters: Characters | None = None,
     ) -> None:
         self.factory = factory or SegmentFactory()
         self.characters = characters or Characters()
 
     def parse(
-        self, message: str, characters: Optional[Characters] = None
+        self, message: str, characters: Characters | None = None
     ) -> Iterator[Segment]:
         """Parse the message into a list of segments.
 
@@ -88,8 +87,8 @@ def parse(
 
     @staticmethod
     def get_control_characters(
-        message: str, characters: Optional[Characters] = None
-    ) -> Optional[Characters]:
+        message: str, characters: Characters | None = None
+    ) -> Characters | None:
         """Read the UNA segment from the passed string and extract/store the control characters from it.
 
         :param message: a valid EDI message string, or UNA segment string,

pydifact/segmentcollection.py

@@ -23,7 +23,7 @@
 import codecs
 import datetime
 from collections.abc import Callable, Iterable, Iterator, Sequence
-from typing import Optional, Type, TypeVar
+from typing import Type, TypeVar
 
 from pydifact.api import EDISyntaxError
 from pydifact.control import Characters
@@ -61,13 +61,13 @@ class AbstractSegmentsContainer:
        The control characters (a :class:`~pydifact.control.Characters` object).
     """
 
-    HEADER_TAG: Optional[str] = None
-    FOOTER_TAG: Optional[str] = None
+    HEADER_TAG: str | None = None
+    FOOTER_TAG: str | None = None
 
     def __init__(
         self,
-        extra_header_elements: Optional[Elements] = None,
-        characters: Optional[Characters] = None,
+        extra_header_elements: Elements | None = None,
+        characters: Characters | None = None,
     ) -> None:
         self.segments: list[Segment] = []
 
@@ -85,8 +85,8 @@ def __init__(
     def from_str(
         cls: Type[T],
         string: str,
-        parser: Optional[Parser] = None,
-        characters: Optional[Characters] = None,
+        parser: Parser | None = None,
+        characters: Characters | None = None,
     ) -> T:
         """Create an instance from a string.
 
@@ -105,7 +105,7 @@ def from_str(
     def from_segments(
         cls: Type[T],
         segments: Iterable[Segment],
-        characters: Optional[Characters] = None,
+        characters: Characters | None = None,
     ) -> T:
         """Create an instance from a list of segments.
 
@@ -124,7 +124,7 @@ def from_segments(
     def get_segments(
         self,
         name: str,
-        predicate: Optional[Callable[[Segment], bool]] = None,
+        predicate: Callable[[Segment], bool] | None = None,
     ) -> Iterator[Segment]:
         """Get all segments that match the requested name.
 
@@ -141,8 +141,8 @@ def get_segments(
     def get_segment(
         self,
         name: str,
-        predicate: Optional[Callable[[Segment], bool]] = None,
-    ) -> Optional[Segment]:
+        predicate: Callable[[Segment], bool] | None = None,
+    ) -> Segment | None:
         """Get the first segment that matches the requested name.
 
         :param name: The name of the segment to return.
@@ -214,7 +214,7 @@ def add_segment(self, segment: Segment) -> None:
         if segment.tag not in (self.HEADER_TAG, self.FOOTER_TAG):
             self.segments.append(segment)
 
-    def get_header_segment(self) -> Optional[Segment]:
+    def get_header_segment(self) -> Segment | None:
         """Craft and return a header segment.
 
         :meth:`get_header_segment` creates and returns an appropriate
@@ -228,7 +228,7 @@ def get_header_segment(self) -> Optional[Segment]:
         """
         return None
 
-    def get_footer_segment(self) -> Optional[Segment]:
+    def get_footer_segment(self) -> Segment | None:
         """Craft and return a footer segment.
 
         This is similar to :meth:`get_header_segment`, but for the footer segment.
@@ -365,7 +365,7 @@ def __init__(
         recipient: Element,
         control_reference: Element,
         syntax_identifier: tuple[str, int],
-        timestamp: Optional[datetime.datetime] = None,
+        timestamp: datetime.datetime | None = None,
         *args,
         **kwargs,
     ):
@@ -453,7 +453,7 @@ def add_message(self, message: Message) -> "Interchange":
 
     @classmethod
     def from_file(
-        cls, file: str, encoding: str = "iso8859-1", parser: Optional[Parser] = None
+        cls, file: str, encoding: str = "iso8859-1", parser: Parser | None = None
     ) -> "Interchange":
         """Create a Interchange instance from a file.
 
@@ -471,7 +471,7 @@ def from_file(
 
     @classmethod
     def from_segments(
-        cls, segments: Iterable[Segment], characters: Optional[Characters] = None
+        cls, segments: Iterable[Segment], characters: Characters | None = None
     ) -> "Interchange":
         segments = iter(segments)
 

pydifact/segments.py

@@ -20,11 +20,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 from abc import abstractmethod
-from typing import Union
 
 from pydifact.api import EDISyntaxError, PluginMount
 
-Element = Union[str, list[str]]
+Element = str | list[str]
 Elements = list[Element]
 
 

pydifact/serializer.py

@@ -19,8 +19,6 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
-from typing import Optional
-
 from pydifact.control.characters import Characters
 import re
 
@@ -30,7 +28,7 @@
 class Serializer:
     """Serialize a bunch of segments into an EDI message string."""
 
-    def __init__(self, characters: Optional[Characters] = None) -> None:
+    def __init__(self, characters: Characters | None = None) -> None:
         super().__init__()
         self.characters = characters or Characters()
         self.replace_map = self.characters.escaped_syntax_dic
@@ -95,14 +93,14 @@ def serialize(
         collection = "".join(collection_parts)
         return collection
 
-    def escape(self, string: Optional[str]) -> str:
+    def escape(self, string: str | None) -> str:
         """Escapes control characters.
 
         :param string: The string to be escaped
         """
 
         if string is None:
             return ""
-        assert type(string) == str, "%s is not a str, it is %s" % (string, type(string))
+        assert isinstance(string, str), "%s is not a str, it is %s" % (string, type(string))
 
         return self.regexp.sub(lambda match: self.replace_map[match.group(0)], string)

pydifact/syntax/common.py

@@ -11,7 +11,6 @@
 """
 
 import re
-from typing import Union
 
 from pydifact import Segment, Characters
 
@@ -59,7 +58,7 @@ class UNASegment(Segment):
 
     tag = "UNA"
 
-    def __init__(self, characters: Union[Characters, str, None] = None):
+    def __init__(self, characters: Characters | str | None = None):
         if not characters:
             characters = Characters()
         assert_an(str(characters), 6)

pydifact/tokenizer.py

@@ -20,7 +20,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 from collections.abc import Iterator
-from typing import Optional
 
 from pydifact.token import Token
 from pydifact.control.characters import Characters
@@ -38,20 +37,20 @@ def __init__(self) -> None:
         self._current_chars: list[str] = []
 
         # The current character from the message we are dealing with.
-        self._char: Optional[str] = ""
+        self._char: str | None = ""
 
         # bool isEscaped If the current character has been escaped.
         self.isEscaped = False
 
         # The control characters for the message
-        self.characters: Optional[Characters] = None
+        self.characters: Characters | None = None
 
         self.token_selector: dict[str, Token.Type] = {}
 
         self._message_index: int = 0
 
     def get_tokens(
-        self, message: str, characters: Optional[Characters] = None
+        self, message: str, characters: Characters | None = None
     ) -> Iterator[Token]:
         """Convert the passed message into tokens.
         :param characters: the Control Characters to use for tokenizing. If omitted, use a default set.
@@ -93,7 +92,7 @@ def read_next_char(self) -> None:
             self.isEscaped = True
             self._char = self.get_next_char()
 
-    def get_next_char(self) -> Optional[str]:
+    def get_next_char(self) -> str | None:
         """Get the next character from the message."""
         try:
             return next(self._message)

pyproject.toml

@@ -17,7 +17,7 @@ classifiers = [
     "Programming Language :: Python :: 3",
     "Topic :: Software Development :: Libraries"
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = []
 
 [project.optional-dependencies]

tests/test_tokenizer.py

@@ -13,7 +13,6 @@
 #
 #    You should have received a copy of the GNU Lesser General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from typing import Optional
 import pytest
 
 from pydifact.token import Token
@@ -29,8 +28,8 @@ def tokenizer() -> Tokenizer:
 
 def _assert_tokens(
     collection: str,
-    expected: Optional[list] = None,
-    error_message: Optional[str] = None,
+    expected: list | None = None,
+    error_message: str | None = None,
 ) -> None:
     """Helper function to accelerate tokenizer testing."""