Types are not exported

[gijswobben]

mypy is complaining that the decorators don't have types:

The package does have types, also on the decorators, but they are not exported because there is not py.typed file. The easy fix is to add this file and release a new version of the package.

More information about py.typed:
https://peps.python.org/pep-0561/
https://mypy.readthedocs.io/en/stable/installed_packages.html

[exaby73]

Hello @gijswobben. Are you getting this error on all decorators, or only some of them? Could you let me know which version of mypy you're using?

[gijswobben]

Hello @gijswobben. Are you getting this error on all decorators, or only some of them? Could you let me know which version of mypy you're using?

All functions, classes and decorators. Please note that I've already provided the solution as well. Simply adding a empty file called py.typed to the root of the library fixes this (see included links). I'm always running the latest version of mypy.

[gijswobben]

@exaby73, FYI:

[exaby73]

Do you get the same for a simple example like:

from firebase_functions import pubsub_fn


@pubsub_fn.on_message_published()
def some_function():
    pass

After running pylint main.py, I get unrelated lints:

************* Module main
main.py:1:0: C0114: Missing module docstring (missing-module-docstring)
main.py:5:0: C0116: Missing function or method docstring (missing-function-docstring)

------------------------------------------------------------------
Your code has been rated at 3.33/10 (previous run: 0.00/10, +3.33)

[gijswobben]

Do you get the same for a simple example like:

from firebase_functions import pubsub_fn


@pubsub_fn.on_message_published()
def some_function():
    pass

After running pylint main.py, I get unrelated lints:

************* Module main
main.py:1:0: C0114: Missing module docstring (missing-module-docstring)
main.py:5:0: C0116: Missing function or method docstring (missing-function-docstring)

------------------------------------------------------------------
Your code has been rated at 3.33/10 (previous run: 0.00/10, +3.33)

Yes, of course....

[exaby73]

Okay so the functions that are decorated are not typed which is the problem, but all the other APIs are typed. This seems like a valid issue and I'll label it. Thanks for catching this one :)

[gijswobben]

Okay so the functions that are decorated are not typed which is the problem, but all the other APIs are typed. This seems like a valid issue and I'll label it. Thanks for catching this one :)

No, you can actually see the types on the decorator function on_message_published. They are there, but types are not exported by default in Python. You have to explicitly export them if you make a library, either through stubs, or by creating a py.typed file.

You can read all about this error on the great documentation by MyPy: https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-library-stubs-or-py-typed-marker

From the documentation:

Mypy will not try inferring the types of any 3rd party libraries you have installed unless they either have declared themselves to be PEP 561 compliant stub package (e.g. with a py.typed file) or have registered themselves on typeshed, the repository of types for the standard library and some 3rd party libraries.

The fix is rather easy, just add a py.typed file.

[exaby73]

You're welcome to make a PR :) If you do, you can read about our contributing guidelines

[gijswobben]

@exaby73, sure, please have a look at:
#169