Comments (6)
I think this is a matter of project choice. I don't think there's a particular best practice consensus here. So I'm inclined to keep things as they are as it's the simplest option.
Also, I don't like needing to import from __main__
if I want access to the main()
function - the double underscores indicate that it's not something that we should normally be importing from.
The main()
function is often needed, for testing or for programmatic access to an application (if the app supports it). Importing that either from the package directory or from a cli
submodule seems natural to me - importing it as
import foo.__main__
foo.__main__.main([my, arguments, to, supply])
feels clumsy (I wouldn't do from foo.__main__ import main
as that would probably clash with my own main
function).
from sampleproject.
Personally, I would say __main__.py
should be kept minimal also.
I like to define main
in a cli
module...
cli.py
:
def main(argv=None):
...
__main__.py
:
import sampleproject.cli
sampleproject.cli.main()
from sampleproject.
Move it into __main__.py
per https://docs.python.org/3/library/__main__.html?
from sampleproject.
Pull request #67
from sampleproject.
__main__.py
still requires a if __name__ == '__main__':
check because any setuptools-created executables will have a different __name__
such as sample.__main__
. Btw, sorry the discussion has ended up in two places.
What do others think about just adding a __main__.py
:
from . import main
if __name__ == '__main__':
main()
?
As an aside, would a comment in __init__.py
suggesting users consider moving their def main():
elsewhere be useful?
from sampleproject.
I think mimicking pip
should generally be fine...
Personally, I find the extra if __name__
check redundant since __main__.py
shouldn't be imported, but maybe that's just me. I would call trying to protect people who do weird things from themselves unpythonic.
My response on the PR is relevant too.
from sampleproject.
Related Issues (20)
- packet queue is empty, aborting HOT 2
- How do you test this? HOT 2
- Tools
- How to include non python configuration files HOT 1
- How to control spelling incorrection even if phonetically sound same HOT 1
- pyproject.toml: references a "python_requires" key that does not exist HOT 2
- help! Executing file is not working HOT 2
- sampleproject doesn't include files `setup.py` and `setup.cfg` (and maybe other) one of the latest published guides claims it should have HOT 1
- Unclear description of "readme" field in pyproject.toml HOT 2
- The package name HOT 3
- TypeError: unhashable type: 'dict' HOT 4
- Should development dependencies be included in the optional section?
- Error in documentation regarding Packaging and Distributing projects using Setuptools
- Stop advertising adding `wheel` as an unconditional PEP 517 build dependency HOT 6
- Should PyPUG editors have access to this project? HOT 3
- Remove Python version 3.7 to unblock tests HOT 1
- Update tox version? And tox best practices? HOT 2
- Sample build breaks if LICENSE.txt file contains GPL2 license text (containing 0x0c) HOT 13
- Flake8 configuration should not use select
- pyproject.toml file don't mention anything about the compatible platforms allowed by Wheel?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sampleproject.