Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add typed marker (PEP561) #167

Merged
merged 1 commit into from
Mar 3, 2022
Merged

Add typed marker (PEP561) #167

merged 1 commit into from
Mar 3, 2022

Conversation

eggplants
Copy link
Collaborator

https://www.python.org/dev/peps/pep-0561/#id13

In order to make packaging and distributing type information as simple and easy as possible, packaging and distribution is done through existing frameworks.

Package maintainers who wish to support type checking of their code MUST add a marker file named py.typed to their package supporting typing. This marker applies recursively: if a top-level package includes it, all its sub-packages MUST support type checking as well. To have this file installed with the package, maintainers can use existing packaging options such as package_data in distutils, shown below.

@codecov
Copy link

codecov bot commented Mar 3, 2022

Codecov Report

Merging #167 (3b31f93) into master (d6ef550) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #167   +/-   ##
=======================================
  Coverage   95.46%   95.46%           
=======================================
  Files          10       10           
  Lines         661      661           
=======================================
  Hits          631      631           
  Misses         30       30           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d6ef550...3b31f93. Read the comment docs.

@akamhy akamhy merged commit 48dcda8 into akamhy:master Mar 3, 2022
@eggplants eggplants deleted the add_typed_marker branch March 3, 2022 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants