Type definitions for single file package #1297

remcohaszing · 2022-11-28T16:35:51Z

remcohaszing
Nov 28, 2022

I would like to make pywakeonlan work with typings. Currently this package ships a single file wakeonlan.py. It seems that I would need to change the file structure to the following:

.
├── LICENSE
├── pyproject.toml
├── README.rst
└── wakeonlan
    ├── __init__.py
    └── py.typed

I like that people can just download wakeonlan.py and run it, so ideally I would like to keep the wakeonlan.py file as-is in the project root. Is that possible?

Answered by erictraut

Nov 28, 2022

Your assumption is correct. You would need to switch to a directory structure to include a py.typed marker file. There is no provision in PEP 561 for marking a single-file package as typed.

View full answer

erictraut · 2022-11-28T17:19:59Z

erictraut
Nov 28, 2022
Collaborator

Your assumption is correct. You would need to switch to a directory structure to include a py.typed marker file. There is no provision in PEP 561 for marking a single-file package as typed.

2 replies

remcohaszing Nov 28, 2022
Author

It's not the answer I was hoping for, but it is the anwer I was looking for. Thank you!

not-my-profile Jan 9, 2023

For single-file .py packages using __init__.py works quite well. However the same cannot be said about packages that are implemented by a single shared library (.so). I just opened #1333 about that. (commenting here so that people interested in this topic find that discussion :)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Type definitions for single file package #1297

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 1 comment 2 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Type definitions for single file package #1297

Uh oh!

Uh oh!

remcohaszing Nov 28, 2022

Replies: 1 comment · 2 replies

Uh oh!

erictraut Nov 28, 2022 Collaborator

Uh oh!

remcohaszing Nov 28, 2022 Author

Uh oh!

not-my-profile Jan 9, 2023

remcohaszing
Nov 28, 2022

Replies: 1 comment 2 replies

erictraut
Nov 28, 2022
Collaborator

remcohaszing Nov 28, 2022
Author