Feature typing2 (#40)

* more typing * mypy work and some docs
jvanasco · Apr 10, 2024 · d1183b4 · d1183b4
1 parent 3f27f1b
commit d1183b4
Show file tree

Hide file tree

Showing 11 changed files with 338 additions and 113 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -22,6 +22,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
+          - "3.12"
         include:
           # ubuntu-latest[22.04] does not have: py36
           - os: "ubuntu-20.04"

diff --git a/CHANGELOG.txt b/CHANGELOG.txt
@@ -2,6 +2,12 @@
     1.0 will be a complete api overhaul
 
 
+0.12.1
+    * typing
+    * added `METADATA_PARSER_FUTURE` environment variable
+        `export METADATA_PARSER_FUTURE=1` to enable
+    * is_parsed_valid_url can accept a ParseResultBytes object now
+
 0.12.0
     * drop python 2.7
     * initial typing support

diff --git a/README.rst b/README.rst
@@ -40,6 +40,10 @@ them proper attention is not guaranteed.
 The current MAJOR release is `0`.
 A `1` MAJOR release is planned, and will have an entirely different structure and API.
 
+Future deprecations will raise warnings.
+
+By populating the following environment variable, future deprecations will raise exceptions:
+    export METADATA_PARSER_FUTURE=1
 
 Installation
 =============

diff --git a/mypy.ini b/mypy.ini
@@ -1,2 +1,15 @@
+[mypy]
+check_untyped_defs = True
+exclude = (?x)(
+      ^setup\.py$
+    | ^workspace-demos\/
+    )
+
+[mypy-httpbin.*]
+ignore_missing_imports = True
+
+[mypy-pytest_httpbin.*]
+ignore_missing_imports = True
+
 [mypy-requests_toolbelt.*]
 ignore_missing_imports = True
diff --git a/setup.cfg b/setup.cfg
@@ -8,6 +8,6 @@ per-file-ignores =
 	src/metadata_parser/__init__.py: E501,I202
 	tests/*: E501
 	tests/_compat.py: F401
-exclude = .eggs/*, .pytest_cache/*, .tox/*, build/*, dist/*
+exclude = .eggs/*, .pytest_cache/*, .tox/*, build/*, dist/*, workspace-demos/*
 application_import_names = metadata_parser
 import_order_style = appnexus
diff --git a/setup.py b/setup.py
@@ -62,6 +62,7 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "Topic :: Text Processing :: Markup :: HTML",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],