Add type annotations to public facing APIs

Author: robsdedude

.editorconfig

@@ -16,7 +16,12 @@ trim_trailing_whitespace = true
 [*.bat]
 end_of_line = crlf
 
-[*.py]
-max_line_length = 79
+[*{.py,pyi}]
 indent_style = space
 indent_size = 4
+
+[*.py]
+max_line_length = 79
+
+[*.pyi]
+max_line_length = 130

.pre-commit-config.yaml

@@ -34,3 +34,11 @@ repos:
         entry: bin/make-unasync
         language: system
         files: "^(neo4j/_async|tests/(unit|integration)/async_|testkitbackend/_async)/.*"
+      - id: mypy
+        name: mypy static type check
+        entry: mypy
+        args: [ --show-error-codes, neo4j, tests, testkitbackend ]
+        'types_or': [ python, pyi ]
+        language: system
+        pass_filenames: false
+        require_serial: true

CHANGELOG.md

@@ -118,6 +118,8 @@
   be used by client code. `Record` should be imported directly from `neo4j`
   instead. `neo4j.data.DataHydrator` and `neo4j.data.DataDeydrator` have been
   removed without replacement.
+- Removed undocumented config options that had no effect:
+  `protocol_version` and `init_size`.
 
 
 ## Version 4.4

bin/make-unasync

@@ -104,6 +104,9 @@ class CustomRule(unasync.Rule):
     def __init__(self, *args, **kwargs):
         super(CustomRule, self).__init__(*args, **kwargs)
         self.out_files = []
+        # it's not pretty, but it works
+        # typing.Awaitable[...] -> typing.Union[...]
+        self.token_replacements["Awaitable"] = "Union"
 
     def _unasync_tokens(self, tokens):
         # copy from unasync to hook into string handling

docs/source/conf.py

@@ -115,6 +115,9 @@
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# Don't include type hints in function signatures
+autodoc_typehints = "description"
+
 
 # -- Options for HTML output ----------------------------------------------
 

neo4j/__init__.py

@@ -108,6 +108,7 @@
     "BoltDriver",
     "Bookmark",
     "Bookmarks",
+    "Config",
     "custom_auth",
     "DEFAULT_DATABASE",
     "Driver",
@@ -117,15 +118,18 @@
     "IPv4Address",
     "IPv6Address",
     "kerberos_auth",
+    "log",
     "ManagedTransaction",
     "Neo4jDriver",
+    "PoolConfig",
     "Query",
     "READ_ACCESS",
     "Record",
     "Result",
     "ResultSummary",
     "ServerInfo",
     "Session",
+    "SessionConfig",
     "SummaryCounters",
     "Transaction",
     "TRUST_ALL_CERTIFICATES",
@@ -135,6 +139,7 @@
     "TrustSystemCAs",
     "unit_of_work",
     "Version",
+    "WorkspaceConfig",
     "WRITE_ACCESS",
 ]