Fix doctests and project script

Author: JamesParrott

pyproject.toml

@@ -30,14 +30,14 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-dev = ["pyshp[test]", "pre-commit", "ruff"]
+dev = ["pyshp[test]", "pre-commit", "ruff", "mypy"]
 test = ["pytest"]
 
 [project.urls]
 Repository = "https://github.com/GeospatialPython/pyshp"
 
 [project.scripts]
-shapefile="__init__:main"
+shapefile="shapefile.__main__:main"
 
 [tool.hatch.build.targets.sdist]
 only-include = ["src", "shapefiles", "test_shapefile.py"]

src/shapefile/__init__.py

@@ -9,17 +9,22 @@
 from __future__ import annotations
 
 import logging
-import sys
 
+from .__main__ import main
 from .__version__ import __version__
-from ._doctest_runner import _test
 from .classes import Field, ShapeRecord, ShapeRecords, Shapes
 from .constants import (
+    FIRST_RING,
+    INNER_RING,
+    MISSING,
     MULTIPATCH,
     MULTIPOINT,
     MULTIPOINTM,
     MULTIPOINTZ,
+    NODATA,
     NULL,
+    OUTER_RING,
+    PARTTYPE_LOOKUP,
     POINT,
     POINTM,
     POINTZ,
@@ -30,7 +35,11 @@
     POLYLINEM,
     POLYLINEZ,
     REPLACE_REMOTE_URLS_WITH_LOCALHOST,
+    RING,
     SHAPETYPE_LOOKUP,
+    SHAPETYPENUM_LOOKUP,
+    TRIANGLE_FAN,
+    TRIANGLE_STRIP,
 )
 from .exceptions import GeoJSON_Error, RingSamplingError, ShapefileException
 from .geometric_calculations import bbox_overlap
@@ -106,6 +115,16 @@
     "MULTIPATCH",
     "SHAPETYPE_LOOKUP",
     "REPLACE_REMOTE_URLS_WITH_LOCALHOST",
+    "SHAPETYPENUM_LOOKUP",
+    "TRIANGLE_STRIP",
+    "TRIANGLE_FAN",
+    "OUTER_RING",
+    "INNER_RING",
+    "FIRST_RING",
+    "RING",
+    "PARTTYPE_LOOKUP",
+    "MISSING",
+    "NODATA",
     "Reader",
     "Writer",
     "fsdecode_if_pathlike",
@@ -164,15 +183,7 @@
     "ShapeRecord",
     "ShapeRecords",
     "bbox_overlap",
+    "main",
 ]
 
 logger = logging.getLogger(__name__)
-
-
-def main() -> None:
-    """
-    Doctests are contained in the file 'README.md', and are tested using the built-in
-    testing libraries.
-    """
-    failure_count = _test()
-    sys.exit(failure_count)

src/shapefile/__main__.py

@@ -0,0 +1,16 @@
+import sys
+
+from ._doctest_runner import _test
+
+
+def main() -> None:
+    """
+    Doctests are contained in the file 'README.md', and are tested using the built-in
+    testing libraries.
+    """
+    failure_count = _test()
+    sys.exit(failure_count)
+
+
+if __name__ == "__main__":
+    main()

src/shapefile/_doctest_runner.py

@@ -1,14 +1,15 @@
 import doctest
 import sys
 from collections.abc import Iterable, Iterator
+from pathlib import Path
 from urllib.parse import urlparse, urlunparse
 
 from .constants import REPLACE_REMOTE_URLS_WITH_LOCALHOST
 
 
 def _get_doctests() -> doctest.DocTest:
     # run tests
-    with open("README.md", "rb") as fobj:
+    with Path("README.md").open("rb") as fobj:
         tests = doctest.DocTestParser().get_doctest(
             string=fobj.read().decode("utf8").replace("\r\n", "\n"),
             globs={},