Comments (4)
Actually, there is a possibility: rename the Python module to typed_argument_parser
instead of tap
. Since it's only used in the import section, the longer name will make almost no difference. Obviously you'd have to bump the version number to 2.0 to do this. (And you can't call it typed_argparse
as that name is also taken!)
from typed-argument-parser.
Hi @juliangilbey,
Thank you for bringing up this issue! We realize this is potentially problematic, but in order to preserve backward compatibility, we think it would be best to stick with the current naming. Since tap.py
is a relatively small package with a very different purpose, we hope that this will not be an issue for most users.
Best,
Jesse and Kyle
from typed-argument-parser.
Yes, indeed, but it makes including it in Debian and other Linux distributions hard because of the package conflict. I also just stumbled upon PEP 423: https://www.python.org/dev/peps/pep-0423/#use-a-single-name
Anyway, I would imagine an upgrading path something like the following:
- V 1.8.0 provides two Python modules:
tap
andtyped_argument_parser
. All of the functionality is moved to the new module, andtap
just re-exports everything fromtyped_argument_parser
with aDeprecationWarning
. - Some time later (maybe a year or so), V 2.0.0 drops the
tap
module and only providestyped_argument_parser
.
Or perhaps these version numbers should be V 2.0.0 and V 2.1.0 instead, so that the DeprecationWarning
is only issued on a new major version.
Then packages which depend on typed_argument_parser >=1.0.0,<2.0.0
will be fine.
Best wishes,
Julian
from typed-argument-parser.
Hi @juliangilbey,
We agree that it would be really nice to have a single name that does not conflict with tap.py
. However, we think that keeping backwards compatibility and the simplicity of writing from tap import Tap
is enough of a reason to keep the current name. Also, other majors projects have multiple names (e.g., scikit-learn
and sklearn
). We're sorry if this causes you any inconvenience!
Best,
Jesse and Kyle
from typed-argument-parser.
Related Issues (20)
- Feature request: improve help text parsing from code comments HOT 1
- typing-extensions 4.6.0 break literal arguments HOT 1
- [Feature request] Easy transition from existing code using argparse HOT 1
- How to use argparse.FileType? HOT 1
- What is the right way to call `set_defaults` HOT 4
- Add useful type hints to `Tap.add_subparsers` HOT 1
- Add useful type hints to `Tap.add_subparser` HOT 5
- Refactor `tapify` to enable subparsers HOT 1
- Type safe way to access subparser arguments? HOT 2
- Fix `tapify` to correctly handle **kwargs HOT 1
- [Suggestion] Allow to reference previous arguments as default values HOT 1
- Allow for multi-line documentation of the function HOT 1
- Tuple parsing with literals HOT 1
- [help] Adding `version` arg to print version but bypassing required args HOT 3
- tapify help string order is random HOT 1
- More convenient syntax for subparsers
- ImportError: cannot import name 'Tap' from 'tap' HOT 3
- What's the best way to create a parser from a Pydantic model? HOT 3
- Human readable JSON for saved Python object HOT 1
- Add support for using the `Annotated` type to provide comments for the help string HOT 1
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 typed-argument-parser.