Package: pyiotools
PLEASE NOTE:This library is currently still under development. The API will likely undergo significant changes that may break any code you write with it.
The documentation will fall out of sync with the updates regularly until development slows down. Use it at your own risk.OverviewProvides several utilities for handling I/O:TheIOHandlerclassApi similar toargparse.ArgumentParser(). Must be used as a context manager, and while in scope theArgument.add()method will act equivalent toArgumentParser.add_argument().IOHandler.process()(equivalent toArgumentParser.parse_args()) returns asubtypes.Dictholding the argument values if no callback is provided to theIOHandler()constructor, otherwise it passes on the return value of the callback function, which will be passed aDictas its single positional argument.Has various run-modes (in the providedRunModeEnum)RunMode.SMARTwill attempt to choose the appropriate run-mode for the situation.UnderRunMode.COMMANDLINEargparse is used under-the-hood to process thesys.argvarguments, but with additional features and custom-built help interface that is more
readable (and way prettier!)UnderRunMode.GUI, it will programatically build a GUI to collect user input, with widgets picked based on the 'argtype' argument ofArgument(). The argument defaults can be
overriden at point-in-time by passing adictof argument name-value pairs directly toIOHandler.process(). Further calls toIOHandler.process()will still have the base
defaultsUnderRunMode.PROGRAMMATIC, the argument values can be passed directly toIOHandler.process()as adictof argument name-value pairsIOHandler.add_subhandler()will add a new subhandler which will act as a subcommand underRunMode.COMMANDLINE, and will act as a tabbed sheet underRunMode.GUI. The handlers
exist in a hierarchy, meaning that arguments passed to all parents on the way to the lowest child sheet (on the gui) or final used subcommand (in the commandline) are still handled.TheArgumentclassTheArgument()constructor arguments tell the IOHandler how to handle nullability, default values, implicit coercion to the right type, whether the argument is optional,
commandline aliases, conditions, dependencies, etc.AnArgTypeEnumis provided to be passed to theArgument(argtype=)constructor argument. This will let theIOHandlerperform type checking and coercion. Currently the
recognized types are:memberwith IOHandler(subtypes=True)with IOHandler(subtypes=False)STRINGsubtypes.StrstrINTEGERintintFLOATfloatfloatDECIMALdecimal.Decimaldecimal.DecimalBOOLEANboolboolLISTsubtypes.ListlistDICTsubtypes.DictdictSETsetsetPATHpathlib.Pathpathlib.PathFILEpathmagic.Filepathmagic.FileDIRpathmagic.Dirpathmagic.DirDATETIMEsubtypes.DateTimedatetime.datetimeFRAMEsubtypes.Framepandas.DataFrameTheValidateclassAn accessor class granting access to several Validator classes through attribute access.Currently supports type checking and implicit coercion of the input value to the following supported types (int,float,bool,str,list,set,dict,subtypes.DateTime,pathlib.Path,pathmagic.File,pathmagic.Dir)Its attributes are:Validate.Int,Validate.Float,Validate.Bool,Validate.Str,Validate.List,Validate.Set,Validate.Dict,Validate.DateTime,Validate.Path,Validate.File,Validate.DirTheValidatorclassesCurrently there areIntegerValidator,FloatValidator,BoolValidator,StringValidator,ListValidator,SetValidator,DictionaryValidator,DateTimeValidator,PathValidator,FileValidator,DirValidatorSome of these validators are implemented as a wrapper over typepy, but the api is different.Validators can handle nullability as desired.Some validators have additional validation methods to check for values in valid ranges. For example:Validate.Int().max_value(7).is_valid(9)would return False.Additional conditions can be added to a validator by passing callbacks that return boolean values toValidator.add_condition()The validator can be reused for any number of values once initially set up.ListValidatorandDictionaryValidatorwill coerce strings by using eval (safely), rather than coercing a string to a list by callinglist()on itTheGuiclass and its various template subclassesGui class and several template subclasses that can be used alongside the variousWidgetManagerobjects to easily set up a GUI, with the exact internals of the
underlying QT classes abstracted away behind a consistent API. Makes it very quick and easy to set up a simple GUI. Is a thin wrapper around PyQt5.ThreePartGuiclass for quickly setting up Horizontal-Vertical-Horizontal guisHTMLGuiclass for Rendering HTML in a separate windowTheWidgetManagerclass and its various widget subclassesCurrently supports the following widgets:Label,Button,Checkbox,CheckBar,DropDown,Entry,Text,FileSelect,DirSelect,Calendar,DateTimeEdit,HtmlDisplay,ProgressBar,Table,ListTable,DictTable,WidgetFrame,HorizontalFrame,VerticalFrameHave a consistent API primarily using the propertiesWidgetManager.active,WidgetManager.state,WidgetManager.text, andWidgetManager.parent.TheConsoleclassOffer choices inveractively on the console, allowing navigation using arrow keysSupports multi-selectOffer YES/NOHide/show consoleClear existing lines from consoleTheScriptclassUses a metaclass that wraps every method and the methods of inner classes (recursively) in a profiler, showing duration, arguments, and return value of each method call,
and arepr()of the script objectWrites this profiling information andprint()statements to a log fileUpon exiting the constructor, optionally serializes the object to the same directory as the logAny**kwargspassed to the constructor are stored in theScript.argumentsattributeTheScript.nameattribute is automatically set to the name of the file the class is defined inFor use withIOHandler, theScript.run_modeattribute is automatically 'smart' by default, but can be overriden by setting it as a class attributeTheCacheclassSerializes any python object that can be pickled by Dill into a fileInterface similar to adictfor interacting with the items in the cache:Cache.put(),Cache.get(),Cache.pop(), andCache.setdefault()TheSerializerclassSerialize/deserialize any object that is pickleable by DillDiscard unpickleable attributes recursively and replace them withLostObjectinstancesTheSecretsclassSerialize, then encrypt any python object and write it to a file and vice-versa.Encryption key must be set before first use. It will be persisted to a json config file at an os-appropriate appdir.InstallationTo install use pip:$ pip install pyiotoolsOr clone the repo:$ git clone https://github.com/matthewgdv/iotools.git
$ python setup.py installUsageUsage examples coming soon.ContributingContributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.You can contribute in many ways:Report BugsReport bugs athttps://github.com/matthewgdv/iotools/issuesIf you are reporting a bug, please include:Your operating system name and version.Any details about your local setup that might be helpful in troubleshooting.Detailed steps to reproduce the bug.Fix BugsLook through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.Implement FeaturesLook through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.Write DocumentationThe repository could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.Submit FeedbackThe best way to send feedback is to file an issue athttps://github.com/matthewgdv/iotools/issues.If you are proposing a new feature:Explain in detail how it would work.Keep the scope as narrow as possible, to make it easier to implement.Remember that this is a volunteer-driven project, and that contributions are welcome :)Get Started!Before you submit a pull request, check that it meets these guidelines:If the pull request adds functionality, it should include tests and the docs should be updated. Write docstrings for any functions that are part of the external API, and add
the feature to the README.md.If the pull request fixes a bug, tests should be added proving that the bug has been fixed. However, no update to the docs is necessary for bugfixes.The pull request should work for the newest version of Python (currently 3.7). Older versions may incidentally work, but are not officially supported.Inline type hints should be used, with an emphasis on ensuring that introspection and autocompletion tools such as Jedi are able to understand the code wherever possible.PEP8 guidelines should be followed where possible, but deviations from it where it makes sense and improves legibility are encouraged. The following PEP8 error codes can be
safely ignored: E121, E123, E126, E226, E24, E704, W503This repository intentionally disallows the PEP8 79-character limit. Therefore, any contributions adhering to this convention will be rejected. As a rule of thumb you should
endeavor to stay under 200 characters except where going over preserves alignment, or where the line is mostly non-algorythmic code, such as extremely long strings or function
calls.