Improve static type checking in setup.py (#221)

Part of #201 Signed-off-by: Omar Mohamed <[email protected]>
matrix-org · Apr 23, 2021 · 2c574ea · 2c574ea
1 parent 860cda0
commit 2c574ea
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/changelog.d/221.misc b/changelog.d/221.misc
@@ -0,0 +1 @@
+Document on improving static type checking using mypy. Contributed by Omar Mohamed.
diff --git a/setup.py b/setup.py
@@ -16,7 +16,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
+import os.path
+from os import PathLike
+from typing import Union
 
 from setuptools import find_packages, setup
 
@@ -25,7 +27,7 @@
 # Used for the long_description.  It's nice, because now 1) we have a top level
 # README file and 2) it's easier to type in the README file than to put a raw
 # string in below ...
-def read(fname):
+def read(fname: Union[str, "PathLike[str]"]) -> str:
     return open(os.path.join(os.path.dirname(__file__), fname)).read()