Entrypoint v.0.1.5

Advertisement
Advertisement

A decorator to interact with argparse based on function signature.This is a decorator library that helps one to write small scripts in Python.There are three main features that it provides: * Automatically running a function when a script is called directly, but not when it is included as a module. * Automatically generating argument parsers from function signatures and docstrings * Automatically opening and closing files (with a codec or as binary) when a function is called and returns.The raison d'?“?„tre of this library is to be convenient, and it makes somesacrifices in other areas. Notably there are some stringent conditions onthe order of application of decorators.For further information, see the explanations below, and the docstrings of thefunctions. To report errors, request features, or submit patches, please emailconrad.irwin@gmail.com.I've tried to comment-out sections of the documentation that are less relevantto people trying to simply use the library. They contain background informationor extra interfaces for re-using components.1) Automatically running a function when the library has been called directly. This is conventionally done in Python using: >>> def main(): ... pass >>> if __name__ == '__main__': ... main(); And can be re-written to >>> @autorun ... def main(): ... pass WARNING: This will not work as expected unless it is the "outermost" decorator, i.e. the decorator that is listed first in the file and applied last to the function. If you only have one decorator, that should be fine - and that's why the library also provides @entrypoint, @entrywithfile and @runwithfile (see table below) so that you only need one decorator. # Specifically, this decorator will call the function as part of the # process of decorating. Thus any decorators that are applied after # this one will not have been applied in the case the function is # called later. # autorun can also be used as a standalone function, which is necessary if # you would like to use this functionality as part of another library. # In such a case you need to pass it a second parameter indicating how far # many levels above in the stack frame within autorun you would expect for # __name__ to equal '__main__'. # >>> def autorunwithone(func): # ... autorun(lambda: func(1), 2) # >>> @autorunwithone # ... def puts(y): # ... print y2) Automatically opening and closing files with the appropriate encoding. This is conventionally done using: >>> from __future__ import with_statement >>> def main(filename): ... with codecs.open(filename, 'r', 'utf-8') as openfile: ... pass And can be re-written to >>> @withfile('r') ... def main(openfile): ... pass It is possible to pass a codec's name as the first positional argument (or as __encoding) to @withfile. The default encoding is stored in entrypoint.ENCODING and is set to 'utf-8'. >>> @withfile('utf-16', 'w') ... def main(openfile): ... pass Or to open files in "binary" mode, with no codec, just suffix the spec with a 'b': >>> @withfile('rb', 'a') ... def main(binaryfile, logfile): ... print >>logfile, process(binaryfile.read()) WARNING: Default arguments to functions are opened and closed on each entry to that function, when a function will be called more than once used 'a' instead of 'w' so that later calls don't overwrite the contents. >>> @withfile('r', 'a') ... def main(readfile, log='/tmp/python.log'): ... log.write("Reading %s" % readfile.name) For clarity, it is possible to give keyword arguments to @withfile, and it is necessary to do so if you wish to open all the arguments provided to the function's *args or **kwargs: >>> @withfile('w', args='r', stderr='a') ... def main(catfile, *args, **kwargs): ... if args: ... catfile.write("n".join(arg.read() for arg in args)) ... elif 'stderr' in kwargs: ... print >>kwargs['stderr'], "Nothing to cat" Finally, following the convention of many command line tools, the special filename '-' is used to refer to sys.stdin for reading, and sys.stdout for writing and appending. Again this can be a default parameter or passed in by the caller: >>> @withfile('r', 'w') ... def main(input, output='-'): ... pass WARNING: The files are opened on entry to the function, not when you need them, if you open a file for writing, it will be created on disk, even if you don't write anything to it.3) Automatically parsing command-line arguments from a function's signature, and, if possible, from its doc-string. Internally, this uses the argparse module, but removes the tedious syntax needed to get the most simple arguments parsed. At its most basic, it simply converts a function that takes several positional arguments (**kwargs is not supported) into a function that takes an optional array of arguments, and defaults to sys.argv[1:] >>> @acceptsargv ... def main(arg1, arg2): ... pass ... ... main() ... main(sys.argv[1:]) ... main(['arg1', 'arg2']) This can be coupled with the other magic above, so that the function is called automatically when it is defined: >>> sys.argv[1:] = ['arg1', 'arg2'] >>> @entrypoint ... def main(arg1, arg2) ... pass The argument parser will abort the program if the arguments don't match, and print a usage message. More detail can be found by passing -h or --help at the command line as is normal. >>> @entrypoint ... def main(arg1, arg2): ... pass usage: test.py [-h] arg1 arg2 : error: too few arguments In addition to compulsary, positional, arguments as demonstrate above it is possible to add flag arguments. Flag arguments are signified by providing a default value for the parameter, of the same type as you wish the user to input. Positional arguments, and flags with a default value of None are always decoded as unicode strings. If the type conversion fails, it is presented to the user as an error. >>> @entrypoint ... def main(filename, priority=1): ... assert isinstance(priority, int) usage: [-h] [--priority PRIORITY] filename If the default value is True or False, the flag will be treated as a toggle to flip that value: >>> @entrypoint ... def main(filename, verbose=False): ... if verbose: ... print filename usage: [-h] [--verbose] filename It is also possible to use the *args of a function: >>> @entrypoint ... def main(output, *input): ... print ", ".join(filenames) usage: [-h] output [input [input ...]] In addition to being able to parse the arguments automatically, @acceptargv can also be used to provide user-facing documentation in the same manner as argparse. It does this by parsing the function's doc string in the following ways: >>> def main(filename, flag=True, verbosity=3): ... """ ... Introductory paragraph. ... ... Description and clarification of arguments. ... ... Epilogue ... ... ---- ... ... Internal documentation ... """ ... pass All parts are optional. The introductory paragraph and the epilogue are shown before and after the summary of arguments generated by argparse. The internal documentation (below the ----) is not displayed at all. = : = [-[,] ] -- [=] = [/] The description can span multiple lines, and will be re-formed when displayed. In the first case, the - gives a one-letter/number abbreviation for setting the flag: >>> def main(flag=True): ... """ ... -f --flag: Set the flag ... """ , , , and are limited to [a-zA-Z][a-zA-Z0-9_-]* The flagname and the argname should match the actual name used in the function argument definition, while the displayname and varname are simply for displaying to the user. Finally, any function that is wrapped in this manner can throw an entrypoint.UsageError, the first parameter of which will be displayed to the user as an error.Several combinations are available as pre-defined decorators: Run Signature Open Automatically Parser Files @autorun X @entrypoint X X @entrywithfile X X X* @runwithfile X X @withfile X @withuserfile X* @acceptargv X* Denotes that FileUsageErrors will be thrown instead of IOErrors to provide more user-friendly error reportingA set of tests can be run by calling "python test.py"#md5=cd5a0df713ab5ba3a85b10116765697d#md5=2bc8862281e519803a51abc4c9ac4f71

A decorator to interact with argparse based on ...

 
  • Entrypoint
  • 0.1.5
  • Conrad Irwin
  • Linux
  • Freeware
  • 10 Kb
  • 149
  • Free
 
 

Review Entrypoint

  • captcha
 
 
New Components & Libraries software
  • FsMediaLibrary.NET  v.2019.11.0fsMediaLibrary is a .NET library designed to save time developing a Media Player or any application that requires the storage of Audio files, Playlist and Track information including cover artwork and Lyrics.
  • Luxand FaceSDK  v.7.2Real-time precision face recognition and identification SDK for C++, C#, Objective C, VB, Java and Delphi. FaceSDK enables developers to build web, Windows, Linux, MacOS X, iOS and Android applications with face recognition functionality.
  • The C# PDF Library  v.2020.9.0IronPDF is a Microsoft C# / VB .Net library making it easy for developers to generate PDF files from within desktop, web, server applications and websites. Use your HTML, ASPX, CSS and JS skills to generate and print PDF files https://ironpdf.com/ ...
  • Dew Lab Studio for Delphi  v.2020.0Dew Lab Studio is an object oriented, multithreaded, vectorized, 64bit, Open CL enabled numerical library for Delphi/C++ 2007/9/10/XE1-8/10/10.1/10.2/10.3. Supports complex numbers, math parser, optimization, signal processing, statistics...
  • Libx1f4l2  v.0.20100808libx1f4l2 is a data structures library.
  • Panya-paste  v.0.0.8Python Paste templates creating Panya buildout environments.