Comments (4)
Good idea.
I agree that annotations should be shown in the help information, when available. We should consider the design of this in conjunction with larger changes to the usage strings. I expect we'll want to show the type annotations separately from the "Usage" section, in order to 1. Keep the usage section clean, and 2. support non-type annotations.
As an example of other changes to help information that we want: When showing the usage info for an object, we should probably separate its callable properties from its noncallable ones visually, possibly showing usage information for its callable members, and maybe the members' docstrings too.
from python-fire.
Yeah you're right, they shouldn't be in the usage section, in that case I think just printing inspect.signature(func)
would be a pretty good solution, that would look like this. Is this what you're thinking? Or do you have better design in mind?
Type: function
String form: <function greeting at 0x00235738>
File: c:\users\admin\desktop\test.py
Line: 4
Signature: (name:str, age:int) -> str
Usage: test.py NAME AGE
test.py --name NAME --age AGE
from python-fire.
That looks nice. Not sure how that will look with more complex annotations. I'll have to play around with it some once I'm at a computer.
If it gets messy, we could consider something like only showing the Signature a) if we're in verbose mode or b) if it doesn't have any non-type annotations.
from python-fire.
@keatinge I'm interested in exactly the case you described. Did you find a way to directly use annotations? (I see fire still doesn't support it, but are there other utilities that do?)
from python-fire.
Related Issues (20)
- [feature request] Exclude function (kw)args from synopsis, arguments and flags in help output
- guide sample code is entered incorrectly HOT 2
- Version flag alongside other commands HOT 3
- Remove test requirement on mock HOT 4
- Is it possible to pass arg via code and kwargs by cli (sys.argv) ? HOT 1
- cli for function created on the fly HOT 1
- ERROR: Could not consume arg: >> HOT 1
- AttributeError: 'module' object has no attribute 'PY34' HOT 1
- How to set the number of args at least one? HOT 1
- Python 2.7 no longer available in GitHub Actions by default HOT 1
- Unexpected printing (+paging) when using inspect HOT 3
- Cannot parse list of strings containing `is` HOT 5
- Gracias
- unable to install fire HOT 4
- Android 14 HOT 1
- What's the meaning of "available commands: as_interger_ratio | bit_count |..." HOT 2
- How to use the avialable command "S.xx", such as S.count HOT 2
- How to pass '2e9672320848' as a str value? HOT 1
- Optional type args are mistyped in help HOT 1
- Have all staff been laid off? 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 python-fire.