Giter VIP home page Giter VIP logo

logicparser's Introduction

logicparser

A free layer to create logics for your arguments

Getting Started

logicparser is a python package that allow you to create logic and dependncies between CLI arguments. These instructions will install logicparser to your machine.

Prerequisites

  • Python3
  • PIP3

Installation

pip3 install logicparser 

Usage

Define arguments

The class used to create a new argument is imported in this way:

from logicparser import Argument

arg = Argument(arg_name='--arg-name')

metavar

arg = Argument(arg_name='--arg-name', metavar='ARG_VALUE')

action

arg = Argument(arg_name='--arg-name', action='store_true')

help

arg = Argument(arg_name='--arg-name', help='This message will be show when you will define -h arg')

Add relationships

require

You can define that an argument can be defined only if others arguments are defined previously

arg = Argument(
    arg_name='arg-name',
    require=('--other-arg',))

conflict

You can define that an argument cannot be defined if other arguments are defined previously

arg = Argument(
    arg_name='arg-name',
    conflict=('--other-arg',))

dependency

You can define that an arguments can be defined only if at least one of others arguments is defined

arg = Argument(
    arg_name='arg-name',
    dependency=('--other-arg1', 'other-arg2',))

Parse arguments

When you have defined the list of your arguments you can play args validation parsing them.

from logicparser import Argument, ArgumentHandler

args = ArgumentHandler([
    Argument(arg_name='--arg-name', ...),
    Argument(arg_name='--arg-name2', ...),
    Argument(arg_name='--arg-name3', ...),
    ...
]).args

Contributing

Please read CONTRIBUTING.md for details on code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License, read LICENSE for details

Author

  • Giuseppe "mastrobirraio" Matranga - Initial work - Github

logicparser's People

Contributors

mastrobirraio avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.