gophermap 0.2.0__tar.gz → 1.1.0__tar.gz

{gophermap-0.2.0 → gophermap-1.1.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: gophermap
-Version: 0.2.0
+Version: 1.1.0
 Summary: A simple library for parsng Gophermaps
 Keywords: Gopher,Gophermap,Hypertext,library,Markup,parser,Small Web,smolweb
 Author: Dave Pearson
 Author-email: Dave Pearson <davep@davep.org>
 License-Expression: MIT
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3

gophermap-1.1.0/pyproject.toml

@@ -0,0 +1,104 @@
+[project]
+name = "gophermap"
+version = "1.1.0"
+description = "A simple library for parsng Gophermaps"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = []
+license = "MIT"
+keywords = [
+    "Gopher",
+    "Gophermap",
+    "Hypertext",
+    "library",
+    "Markup",
+    "parser",
+    "Small Web",
+    "smolweb",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+
+[[project.authors]]
+name = "Dave Pearson"
+email = "davep@davep.org"
+
+[project.urls]
+Homepage = "https://gophermap.davep.dev/"
+Repository = "https://github.com/davep/gophermap"
+Documentation = "https://gophermap.davep.dev/"
+Source = "https://github.com/davep/gophermap"
+Issues = "https://github.com/davep/gophermap/issues"
+Discussions = "https://github.com/davep/gophermap/discussions"
+
+[project.scripts]
+gophermap = "gophermap.__main__:parse_input"
+
+[build-system]
+requires = ["uv_build>=0.11.32,<0.12.0"]
+build-backend = "uv_build"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+
+[tool.pyright]
+venvPath = "."
+venv = ".venv"
+exclude = [".venv"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "UP",
+    "B",
+    "SIM",
+    "I",
+]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120
+
+[tool.coverage.run]
+omit = ["tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    'class .*\bProtocol\):',
+    '@(abc\.)?abstractmethod',
+]
+
+[dependency-groups]
+dev = [
+    "codespell>=2.4.3",
+    "mypy>=2.3.0",
+    "pre-commit>=4.6.0",
+    "ruff>=0.15.22",
+]
+docs = [
+    "mkdocs>=1.6.1,<2",
+    "mkdocs-material>=9.7.6",
+    "mkdocstrings[python]>=1.0.4",
+]
+test = [
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+]

gophermap-0.2.0/pyproject.toml → gophermap-1.1.0/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "gophermap"
-version = "0.2.0"
+version = "1.1.0"
 description = "A simple library for parsng Gophermaps"
 readme = "README.md"
 authors = [
@@ -20,7 +20,7 @@ keywords = [
     "smolweb",
 ]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3",

{gophermap-0.2.0 → gophermap-1.1.0}/src/gophermap/__init__.py

@@ -16,7 +16,7 @@ __licence__ = "MIT"
 
 ##############################################################################
 # Local imports.
-from .exceptions import GopherMapError, NoFields
+from .exceptions import GopherMapError
 from .gopher_map import GopherMap
 from .item import GopherItem
 from .item_type import ItemType
@@ -28,7 +28,6 @@ __all__ = [
     "GopherMap",
     "GopherMapError",
     "ItemType",
-    "NoFields",
 ]
 
 ### __init__.py ends here

gophermap-1.1.0/src/gophermap/exceptions.py

@@ -0,0 +1,24 @@
+"""Provides exceptions for the Gopher map."""
+
+
+##############################################################################
+class GopherMapError(Exception):
+    """Base class for Gopher map errors."""
+
+
+##############################################################################
+class EmptyMap(GopherMapError):
+    """Raised when a Gopher map is empty."""
+
+
+##############################################################################
+class NoFields(GopherMapError):
+    """Raised when a Gopher item has no fields."""
+
+
+##############################################################################
+class UnknownItemType(GopherMapError):
+    """Raised when a Gopher item has an unknown type."""
+
+
+### exceptions.py ends here

gophermap-1.1.0/src/gophermap/gopher_map.py

@@ -0,0 +1,117 @@
+"""Provides a class for parsing and holding a Gopher map."""
+
+##############################################################################
+# Python imports.
+from collections.abc import Iterator
+from functools import cached_property
+from typing import Final
+
+##############################################################################
+# Local imports.
+from .exceptions import EmptyMap, GopherMapError
+from .item import GopherItem
+from .item_type import ItemType
+
+##############################################################################
+EOF: Final[str] = "."
+"""The EOF marker for a Gopher map."""
+
+
+##############################################################################
+class GopherMap:
+    """A class for parsing and holding a Gopher map."""
+
+    def __init__(self, map_text: str, strict: bool = False) -> None:
+        """Initialise the Gopher map.
+
+        Args:
+            map_text: The text of the Gopher map.
+            strict: Whether to be strict about parsing the Gopher map.
+        """
+        self._raw = map_text
+        """The raw text of the Gopher map."""
+        self._strict = strict
+        """Whether to be strict about parsing the Gopher map."""
+
+    def _parse_map(self, map_text: str) -> Iterator[GopherItem]:
+        """Parse the Gopher map text into a list of Gopher items.
+
+        Args:
+            map_text: The text of the Gopher map.
+
+        Yields:
+            Gopher items.
+        """
+        if self._strict and not map_text:
+            raise EmptyMap("Gopher map is empty")
+        for line in map_text.splitlines():
+            if line == EOF:
+                break
+            yield GopherItem(line, self._strict)
+
+    @property
+    def raw(self) -> str:
+        """The raw text of the Gopher map."""
+        return self._raw
+
+    @cached_property
+    def items(self) -> tuple[GopherItem, ...]:
+        """The list of Gopher items in the map.
+
+        Raises:
+            EmptyMap: If the map is empty and strict mode is enabled.
+            NoFields: If the line is missing a tab character and strict mode is enabled.
+            UnknownItemType: If the item type is unknown and strict mode is enabled.
+        """
+        return tuple(self._parse_map(self._raw))
+
+    @cached_property
+    def has_error(self) -> bool:
+        """Whether the Gopher map contains an error item.
+
+        Raises:
+            EmptyMap: If the map is empty and strict mode is enabled.
+            NoFields: If the line is missing a tab character and strict mode is enabled.
+            UnknownItemType: If the item type is unknown and strict mode is enabled.
+
+        Note:
+            The mentioned exceptions will be raised on accessing this
+            property, if in strict mode. If you wish to check for errors
+            without raising exceptions, use the [`is_likely_error` class
+            method][gophermap.GopherMap.is_likely_error], to test instead.
+        """
+        return any(item.type is ItemType.ERROR for item in self.items)
+
+    @classmethod
+    def is_likely_a_map(cls, text: str) -> bool:
+        """Determine if the text is likely a valid Gopher map.
+
+        Args:
+            text: The text of the Gopher map.
+
+        Returns:
+            True if the text is likely a valid Gopher map, False otherwise.
+        """
+        try:
+            _ = cls(text, strict=True).items
+        except GopherMapError:
+            return False
+        return True
+
+    @classmethod
+    def is_likely_error(cls, text: str) -> bool:
+        """Determine if the text is likely a Gopher error message.
+
+        Args:
+            text: The text to test.
+
+        Returns:
+            True if the text is likely a Gopher error message, False otherwise.
+        """
+        try:
+            return cls(text, strict=True).has_error
+        except GopherMapError:
+            return False
+
+
+### gopher_map.py ends here

{gophermap-0.2.0 → gophermap-1.1.0}/src/gophermap/item.py

@@ -2,6 +2,7 @@
 
 ##############################################################################
 # Local imports.
+from .exceptions import NoFields, UnknownItemType
 from .item_type import ItemType
 
 
@@ -9,11 +10,16 @@ from .item_type import ItemType
 class GopherItem:
     """A class for holding an item in the Gopher map."""
 
-    def __init__(self, line: str) -> None:
+    def __init__(self, line: str, strict: bool = False) -> None:
         """Initialise the Gopher item.
 
         Args:
             line: The line of text from the Gopher map.
+            strict: Whether to be strict about parsing the Gopher item.
+
+        Raises:
+            NoFields: If the line is missing a tab character and strict mode is enabled.
+            UnknownItemType: If the item type is unknown and strict mode is enabled.
         """
         self._raw = line
         """The raw text of the Gopher item."""
@@ -29,6 +35,12 @@ class GopherItem:
         """The host of the Gopher item."""
         self._port = int(fields[3]) if len(fields) > 3 and fields[3].isdigit() else 70
         """The port of the Gopher item."""
+        # If we're in strict mode, let's do some harsh checks.
+        if strict:
+            if "\t" not in line:
+                raise NoFields(f"Line is missing a tab character: {line!r}")
+            if self._type is ItemType.UNKNOWN:
+                raise UnknownItemType(f"Unknown item type: {self._type!r}")
 
     @property
     def raw(self) -> str:

{gophermap-0.2.0 → gophermap-1.1.0}/src/gophermap/item_type.py

@@ -45,8 +45,12 @@ class ItemType(StrEnum):
     """A document file."""
     AUDIO = "s"
     """An audio file."""
+    PNG = "p"
+    """A PNG image."""
     PDF = "P"
     """A PDF file."""
+    RTF = "r"
+    """A rich text format file."""
     XML = "X"
     """An XML file."""
     UNKNOWN = "unknown"
@@ -92,6 +96,8 @@ class ItemType(StrEnum):
             ItemType.AUDIO: "application/octet-stream",
             ItemType.PDF: "application/pdf",
             ItemType.XML: "application/xml",
+            ItemType.PNG: "image/png",
+            ItemType.RTF: "application/rtf",
         }.get(self, "application/x-gopher-unknown")
 
 

gophermap-0.2.0/src/gophermap/exceptions.py

@@ -1,28 +0,0 @@
-"""Exceptions for the library.
-
-Note:
-    This module is now deprecated and will be removed in a future release.
-"""
-
-
-##############################################################################
-class GopherMapError(Exception):
-    """Base exception for all errors raised by the GopherMap library.
-
-    Note:
-        This exception class is now deprecated and will be removed in a
-        future release.
-    """
-
-
-##############################################################################
-class NoFields(GopherMapError):
-    """Raised when a Gopher item has no fields.
-
-    Note:
-        This exception class is now deprecated and will be removed in a
-        future release.
-    """
-
-
-### exceptions.py ends here

gophermap-0.2.0/src/gophermap/gopher_map.py

@@ -1,57 +0,0 @@
-"""Provides a class for parsing and holding a Gopher map."""
-
-##############################################################################
-# Python imports.
-from collections.abc import Iterator
-from functools import cached_property
-from typing import Final
-
-##############################################################################
-# Local imports.
-from .item import GopherItem
-
-##############################################################################
-EOF: Final[str] = "."
-"""The EOF marker for a Gopher map."""
-
-
-##############################################################################
-class GopherMap:
-    """A class for parsing and holding a Gopher map."""
-
-    def __init__(self, map_text: str) -> None:
-        """Initialise the Gopher map.
-
-        Args:
-            map_text: The text of the Gopher map.
-        """
-        self._raw = map_text
-        """The raw text of the Gopher map."""
-
-    @staticmethod
-    def _parse_map(map_text: str) -> Iterator[GopherItem]:
-        """Parse the Gopher map text into a list of Gopher items.
-
-        Args:
-            map_text: The text of the Gopher map.
-
-        Yields:
-            Gopher items.
-        """
-        for line in map_text.splitlines():
-            if line == EOF:
-                break
-            yield GopherItem(line)
-
-    @property
-    def raw(self) -> str:
-        """The raw text of the Gopher map."""
-        return self._raw
-
-    @cached_property
-    def items(self) -> tuple[GopherItem, ...]:
-        """The list of Gopher items in the map."""
-        return tuple(self._parse_map(self._raw))
-
-
-### gopher_map.py ends here