From 953de7488a6bdee01147af1e78bdb4ffc3e5858a Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Fri, 26 Apr 2019 21:53:42 +0200 Subject: [PATCH] [DEV] first version --- .gitignore | 9 + .gitlab-ci.yml | 34 ++++ .travis.yml | 74 ++++++++ LICENSE | 373 +++++++++++++++++++++++++++++++++++++++ MANIFEST.in | 2 + death/ArgDefine.py | 125 +++++++++++++ death/ArgElement.py | 53 ++++++ death/ArgSection.py | 64 +++++++ death/ArgVolatile.py | 93 ++++++++++ death/Arguments.py | 227 ++++++++++++++++++++++++ death/__init__.py | 14 ++ pylintRcFile.txt | 411 +++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 0 setup.py | 46 +++++ 14 files changed, 1525 insertions(+) create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 death/ArgDefine.py create mode 100644 death/ArgElement.py create mode 100644 death/ArgSection.py create mode 100644 death/ArgVolatile.py create mode 100644 death/Arguments.py create mode 100755 death/__init__.py create mode 100644 pylintRcFile.txt create mode 100644 setup.cfg create mode 100755 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d1d26cd --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Compiled python modules. +*.pyc + +# Setuptools distribution folder. +/dist/ +/build/ + +# Python egg metadata, regenerated from source files by setuptools. +/*.egg-info \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..98ab1b7 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,34 @@ +# This file is a template, and might need editing before it works on your project. +# use the official gcc image, based on debian +# can use verions as well, like gcc:5.2 +# see https://hub.docker.com/_/gcc/ +image: gcc + +before_script: + - pwd + - git clone --depth 1 --branch master https://gitlab.com/atria-soft/ci.git + - ls -l * + - ls -l .. + - apt-get update -qy + - apt-get install -y python-dev python-pip + #- pip install setuptools + - ./setup.py install + #- export PYTHONPATH=$PYTHONPATH:./lutin/build/lib.linux-x86_64-2.7/:./lutin/build/lib.linux-x86_64-2.7/lutin/:./lutin/build/lib:./lutin/build/lib/lutin/ +# - ./ci/build_send.py --tag=$TAG --status=START; + + +build: + stage: build + # instead of calling g++ directly you can also use some build toolkit like make + # install the necessary build tools when needed + # before_script: + # - apt update && apt -y install make autoconf + script: + - export TARGET=-tLinux + - export CONF=-mdebug + - export BUILDER=-cgcc + - lutin -w -j4 -C -P $TARGET $BUILDER $COMPILATOR_OPTION $BUS $CONF $GCOV $DISABLE_PACKAGE test-c; STATUS=$? +# - ./ci/build_send.py --tag=$TAG --status="$STATUS"; +# artifacts: +# paths: +# - mybinary diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..8480634 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,74 @@ +language: cpp + +#sudo: false +sudo: required +dist: trusty + +branches: + only: + - master + - dev + +addons: + apt: + sources: + - ubuntu-toolchain-r-test + packages: + - g++-4.9 + - expect + - binutils-mingw-w64-i686 # 32bit MinGW + - gcc-mingw-w64-i686 + - g++-mingw-w64-i686 + - binutils-mingw-w64-x86-64 # 64bit MinGW + - gcc-mingw-w64-x86-64 + - g++-mingw-w64-x86-64 + +matrix: + include: + - os: linux + env: CONF=release BUILDER=gcc TARGET=Linux TAG=Linux COMPILATOR_OPTION="--compilator-version=4.9" + compiler: gcc + - os: linux + env: CONF=debug BUILDER=clang TARGET=Linux + compiler: clang + - os: linux + env: CONF=release BUILDER=gcc TARGET=Windows TAG=Mingw + compiler: x86_64-w64-mingw32-gcc + - os: linux + env: CONF=release BUILDER=gcc TARGET=Android TAG=Android DISABLE_PACKAGE=-p + compiler: gcc + - os: osx + env: CONF=release BUILDER=clang TARGET=MacOs TAG=MacOs + compiler: clang + - os: osx + env: CONF=release BUILDER=clang TARGET=IOs TAG=IOs + compiler: clang + +install: + - ./setup.py build + - export PYTHONPATH=$PYTHONPATH:./lutin/build/lib.linux-x86_64-2.7/:./lutin/build/lib.linux-x86_64-2.7/lutin/:./lutin/build/lib:./lutin/build/lib/lutin/ + - cd .. + # download NDK + - if [ "$TAG" == "Android" ]; then + git clone --depth 1 --branch master https://github.com/HeeroYui/android-download-tool; + ./android-download-tool/dl-android.sh; + fi + - git clone --depth 1 --branch master https://github.com/atria-soft/ci.git + - cd - + +before_script: + - cd .. + - pwd + - ls -l + - if [ "$TRAVIS_OS_NAME" == "osx" ]; then + export PATH=$PATH:/Users/travis/Library/Python/2.7/bin/; + fi + - ./ci/build_send.py --tag=$TAG --status=START; + +script: + - ./lutin/build/scripts-2.7/lutin -w -j4 -C -P -t $TARGET -c $BUILDER $COMPILATOR_OPTION $BUS -m $CONF $GCOV $DISABLE_PACKAGE test-c; STATUS=$? + - ./ci/build_send.py --tag=$TAG --status="$STATUS"; + +notifications: + email: + - yui.heero@gmail.com diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fa0086a --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..cd887dc --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst +include bash-autocompletion/death diff --git a/death/ArgDefine.py b/death/ArgDefine.py new file mode 100644 index 0000000..0aec2d4 --- /dev/null +++ b/death/ArgDefine.py @@ -0,0 +1,125 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## +import sys +from realog import debug + +## +## @brief Declare a possibility of an argument value +## +class ArgDefine: + ## + ## @brief Contructor. + ## @param[in] self Class handle + ## @param[in] smallOption (char) Value for the small option ex: '-v' '-k' ... 1 single char element (no need of '-') + ## @param[in] bigOption (string) Value of the big option name ex: '--verbose' '--kill' ... stated with -- and with the full name (no need of '--') + ## @param[in] list ([[string,string],...]) Optionnal list of availlable option: '--mode=debug' ==> [['debug', 'debug mode'],['release', 'release the software']] + ## @param[in] desc (string) user friendly description with this parameter (default "") + ## @param[in] haveParam (bool) The option must have a parameter (default False) + ## + def __init__(self, + smallOption="", # like v for -v + bigOption="", # like verbose for --verbose + list=[], # ["val", "description"] + desc="", + haveParam=False): + self.option_small = smallOption; + self.option_big = bigOption; + self.list = list; + if len(self.list)!=0: + self.have_param = True + else: + if True==haveParam: + self.have_param = True + else: + self.have_param = False + self.description = desc; + + def is_parsable(self): + return True + ## + ## @brief Get the small name of the option ex: '-v' + ## @param[in] self Class handle + ## @return (string) Small name value + ## + def get_option_small(self): + return self.option_small + + ## + ## @brief Get the big name of the option ex: '--verbose' + ## @param[in] self Class handle + ## @return (string) Big name value + ## + def get_option_big(self): + return self.option_big + + ## + ## @brief Get the status of getting user parameter value + ## @param[in] self Class handle + ## @return True The user must write a value + ## @return False The user must NOT write a value + ## + def need_parameters(self): + return self.have_param + + ## + ## @brief Compatibility with @ref ArgSection class + ## @param[in] self Class handle + ## @return (string) empty string + ## + def get_porperties(self): + return "" + + ## + ## @brief Check if the user added value is correct or not with the list of availlable value + ## @param[in] self Class handle + ## @param[in] argument (string) User parameter value (string) + ## @return True The parameter is OK + ## @return False The parameter is NOT Availlable + ## + def check_availlable(self, argument): + if len(self.list)==0: + return True + for element,desc in self.list: + if element == argument: + return True + return False + + ## + ## @brief Display the argument property when user request help + ## @param[in] self Class handle + ## + def display(self): + color = debug.get_color_set() + if self.option_small != "" and self.option_big != "": + print(" " + color['red'] + "-" + self.option_small + "" + color['default'] + " / " + color['red'] + "--" + self.option_big + color['default']) + elif self.option_small != "": + print(" " + color['red'] + "-" + self.option_small + color['default']) + elif self.option_big != "": + print(" " + color['red'] + "--" + self.option_big + color['default']) + else: + print(" ???? ==> internal error ...") + if self.description != "": + print(" " + self.description) + if len(self.list)!=0: + hasDescriptiveElement=False + for val,desc in self.list: + if desc!="": + hasDescriptiveElement=True + break; + if hasDescriptiveElement==True: + for val,desc in self.list: + print(" " + val + " : " + desc) + else: + tmpElementPrint = "" + for val,desc in self.list: + if len(tmpElementPrint)!=0: + tmpElementPrint += " / " + tmpElementPrint += val + print(" { " + tmpElementPrint + " }") diff --git a/death/ArgElement.py b/death/ArgElement.py new file mode 100644 index 0000000..9533d3b --- /dev/null +++ b/death/ArgElement.py @@ -0,0 +1,53 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## +import sys +from realog import debug + +## +## @brief Single argument class. It permit to define the getted argument. +## +class ArgElement: + ## + ## @brief Contructor. + ## @param[in] self Class handle + ## @param[in] option (string) Option name (write in fullmode ex: '--verbose' even if user write '-v') + ## @param[in] value (string) Writed value by the user (defult '') + ## + def __init__(self, option, value=""): + self.option = option; + self.arg = value; + + ## + ## @brief Get the name of the argument: (write in fullmode ex: '--verbose' even if user write '-v') + ## @param[in] self Class handle + ## @return (string) The argument name + ## + def get_option_name(self): + return self.option + + ## + ## @brief Get argument data set by the user + ## @param[in] self Class handle + ## @return (string) The argument value + ## + def get_arg(self): + return self.arg + + ## + ## @brief Display the Argument property + ## @param[in] self Class handle + ## + def display(self): + if len(self.arg) == 0: + debug.info("option : " + self.option) + elif len(self.option) == 0: + debug.info("element : " + self.arg) + else: + debug.info("option : " + self.option + ":" + self.arg) diff --git a/death/ArgSection.py b/death/ArgSection.py new file mode 100644 index 0000000..38e2858 --- /dev/null +++ b/death/ArgSection.py @@ -0,0 +1,64 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## +import sys +from realog import debug + +## +## @brief Section Class definition (permit to add a comment when requesting help +## +class ArgSection: + ## + ## @brief Constructor + ## @param[in] self Class handle + ## @param[in] sectionName (string) Name of the cestion ex: "option" is displayed [option] + ## @param[in] desc (string) Comment assiciated with the group + ## + def __init__(self, + sectionName="", + desc=""): + self.section = sectionName; + self.description = desc; + + def is_parsable(self): + return False + + ## + ## @brief Compatibility with @ref ArgDefine class + ## @param[in] self Class handle + ## @return empty string + ## + def get_option_small(self): + return "" + + ## + ## @brief Compatibility with @ref ArgDefine class + ## @param[in] self Class handle + ## @return empty string + ## + def get_option_big(self): + return "" + + ## + ## @brief get property print value with the correct writing mode + ## @param[in] self Class handle + ## @return String to display in the short line help + ## + def get_porperties(self): + color = debug.get_color_set() + return " [" + color['blue'] + self.section + color['default'] + "]" + + ## + ## @brief Display the argument property when user request help + ## @param[in] self Class handle + ## + def display(self): + color = debug.get_color_set() + print(" [" + color['blue'] + self.section + color['default'] + "] : " + self.description) + diff --git a/death/ArgVolatile.py b/death/ArgVolatile.py new file mode 100644 index 0000000..5bb6bda --- /dev/null +++ b/death/ArgVolatile.py @@ -0,0 +1,93 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## +import sys +from realog import debug + +## +## @brief Declare an argument value and store it in a parameter +## +class ArgVolatile: + ## + ## @brief Contructor. + ## @param[in] self Class handle + ## @param[in] dest_option (string) Where to store the option name + ## @param[in] optionnal (bool) this element can be not present + ## @param[in] desc (string) user friendly description with this parameter (default "") + ## + def __init__(self, + dest_option="", + optionnal=False, + desc=""): + self.dest_option = dest_option; + if dest_option == "": + debug.error("volatil argument must be store in an argument name") + self.optionnal = optionnal; + self.description = desc; + self.count = 0; + + def is_parsable(self): + return False + ## + ## @brief Get the small name of the option ex: '-v' + ## @param[in] self Class handle + ## @return (string) Small name value + ## + def get_option_small(self): + return "" + + ## + ## @brief Get the big name of the option ex: '--verbose' + ## @param[in] self Class handle + ## @return (string) Big name value + ## + def get_option_big(self): + return self.dest_option + + ## + ## @brief Get the status of getting user parameter value + ## @param[in] self Class handle + ## @return True The user must write a value + ## @return False The user must NOT write a value + ## + def need_parameters(self): + if self.count == 0: + self.count += 1 + return True + return False + + ## + ## @brief Compatibility with @ref ArgSection class + ## @param[in] self Class handle + ## @return (string) empty string + ## + def get_porperties(self): + return " [" + self.dest_option + "]" + + ## + ## @brief Check if the user added value is correct or not with the list of availlable value + ## @param[in] self Class handle + ## @param[in] argument (string) User parameter value (string) + ## @return True The parameter is OK + ## @return False The parameter is NOT Availlable + ## + def check_availlable(self, argument): + return True + + ## + ## @brief Display the argument property when user request help + ## @param[in] self Class handle + ## + def display(self): + color = debug.get_color_set() + print(" " + color['red'] + "[" + self.dest_option + "]" + color['default']) + if self.optionnal == True: + print("(OPTIONNAL)") + if self.description != "": + print(" " + self.description) diff --git a/death/Arguments.py b/death/Arguments.py new file mode 100644 index 0000000..c20fc03 --- /dev/null +++ b/death/Arguments.py @@ -0,0 +1,227 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## +import sys +from realog import debug +from . import ArgDefine +from . import ArgElement +from . import ArgSection +from . import ArgVolatile +from . import ArgDefine + +## +## @brief Class to define the agmument list availlable for a program +## +class Arguments: + ## + ## @brief Constructor. + ## @param[in] self Class handle + ## + def __init__(self): + self.list_properties = [] + self._list_element_stop = [] + self._last_element_parsed = 0 + + ## + ## @brief Add a new argument possibilities... + ## @param[in] self Class handle + ## @param[in] smallOption (char) Value for the small option ex: '-v' '-k' ... 1 single char element (no need of '-') + ## @param[in] bigOption (string) Value of the big option name ex: '--verbose' '--kill' ... stated with -- and with the full name (no need of '--') + ## @param[in] list ([[string,string],...]) Optionnal list of availlable option: '--mode=debug' ==> [['debug', 'debug mode'],['release', 'release the software']] + ## @param[in] desc (string) user friendly description with this parameter (default "") + ## @param[in] haveParam (bool) The option must have a parameter (default False) + ## + def add(self, smallOption="", bigOption="", list=[], desc="", haveParam=False): + self.list_properties.append(ArgDefine.ArgDefine(smallOption, bigOption, list, desc, haveParam)) + + def add_arg(self, destOption="", optionnal=False, desc=""): + self.list_properties.append(ArgVolatile.ArgVolatile(destOption, optionnal, desc)) + + ## + ## @brief Add section on argument list + ## @param[in] self Class handle + ## @param[in] sectionName (string) Name of the cestion ex: "option" is displayed [option] + ## @param[in] sectionDesc (string) Comment assiciated with the group + ## + def add_section(self, sectionName, sectionDesc): + self.list_properties.append(ArgSection.ArgSection(sectionName, sectionDesc)) + + ## + ## @brief Parse the argument set in the command line + ## @param[in] self Class handle + ## @param[in] start_position_parsing position to start the parsing in the arguments + ## + def parse(self, start_position_parsing=1): + list_argument = [] # composed of list element + not_parse_next_element=False + for iii in range(start_position_parsing, len(sys.argv)): + self._last_element_parsed = iii + # special case of parameter in some elements + if not_parse_next_element == True: + not_parse_next_element = False + continue + debug.verbose("parse [" + str(iii) + "]=" + sys.argv[iii]) + argument = sys.argv[iii] + # check if we get a stop parsing element: + if argument in self._list_element_stop: + debug.warning("stop at position: " + str(iii)) + list_argument.append(ArgElement.ArgElement("", argument)) + break; + optionList = argument.split("=") + debug.verbose(str(optionList)) + if type(optionList) == type(str()): + option = optionList + else: + option = optionList[0] + optionParam = argument[len(option)+1:] + debug.verbose(option) + argument_found=False; + if option[:2] == "--": + # big argument + for prop in self.list_properties: + if prop.is_parsable()==False: + continue + if prop.get_option_big()=="": + continue + if prop.get_option_big() == option[2:]: + # find it + debug.verbose("find argument 2 : " + option[2:]) + if prop.need_parameters()==True: + internalSub = option[2+len(prop.get_option_big()):] + if len(internalSub)!=0: + if len(optionParam)!=0: + # wrong argument ... + debug.warning("maybe wrong argument for : '" + prop.get_option_big() + "' cmdLine='" + argument + "'") + prop.display() + continue + optionParam = internalSub + if len(optionParam)==0: + #Get the next parameters + if len(sys.argv) > iii+1: + optionParam = sys.argv[iii+1] + not_parse_next_element=True + else : + # missing arguments + debug.warning("parsing argument error : '" + prop.get_option_big() + "' Missing : subParameters ... cmdLine='" + argument + "'") + prop.display() + exit(-1) + if prop.check_availlable(optionParam)==False: + debug.warning("argument error : '" + prop.get_option_big() + "' SubParameters not availlable ... cmdLine='" + argument + "' option='" + optionParam + "'") + prop.display() + exit(-1) + list_argument.append(ArgElement.ArgElement(prop.get_option_big(),optionParam)) + argument_found = True + else: + if len(optionParam)!=0: + debug.warning("parsing argument error : '" + prop.get_option_big() + "' need no subParameters : '" + optionParam + "' cmdLine='" + argument + "'") + prop.display() + list_argument.append(ArgElement.ArgElement(prop.get_option_big())) + argument_found = True + break; + if argument_found == False: + debug.error("UNKNOW argument : '" + argument + "'") + elif option[:1]=="-": + # small argument + for prop in self.list_properties: + if prop.is_parsable()==False: + continue + if prop.get_option_small()=="": + continue + if prop.get_option_small() == option[1:1+len(prop.get_option_small())]: + # find it + debug.verbose("find argument 1 : " + option[1:1+len(prop.get_option_small())]) + if prop.need_parameters()==True: + internalSub = option[1+len(prop.get_option_small()):] + if len(internalSub)!=0: + if len(optionParam)!=0: + # wrong argument ... + debug.warning("maybe wrong argument for : '" + prop.get_option_big() + "' cmdLine='" + argument + "'") + prop.display() + continue + optionParam = internalSub + if len(optionParam)==0: + #Get the next parameters + if len(sys.argv) > iii+1: + optionParam = sys.argv[iii+1] + not_parse_next_element=True + else : + # missing arguments + debug.warning("parsing argument error : '" + prop.get_option_big() + "' Missing : subParameters cmdLine='" + argument + "'") + prop.display() + exit(-1) + if prop.check_availlable(optionParam)==False: + debug.warning("argument error : '" + prop.get_option_big() + "' SubParameters not availlable ... cmdLine='" + argument + "' option='" + optionParam + "'") + prop.display() + exit(-1) + list_argument.append(ArgElement.ArgElement(prop.get_option_big(),optionParam)) + argument_found = True + else: + if len(optionParam)!=0: + debug.warning("parsing argument error : '" + prop.get_option_big() + "' need no subParameters : '" + optionParam + "' cmdLine='" + argument + "'") + prop.display() + list_argument.append(ArgElement.ArgElement(prop.get_option_big())) + argument_found = True + break; + + if argument_found==False: + # small argument + for prop in self.list_properties: + if prop.is_parsable() == True \ + or prop.get_option_big() == "": + continue + if prop.need_parameters() == True: + list_argument.append(ArgElement.ArgElement(prop.get_option_big(), argument)) + argument_found = True + break + if argument_found==False: + #unknow element ... ==> just add in the list ... + debug.verbose("unknow argument : " + argument) + list_argument.append(ArgElement.ArgElement("", argument)) + + for prop in self.list_properties: + if prop.is_parsable() == True \ + or prop.get_option_big() == "": + continue + if prop.need_parameters() == True \ + and prop.optionnal == False: + debug.error("Missing argument:" + prop.get_option_big()) + #for argument in list_argument: + # argument.display() + #exit(0) + return list_argument; + + ## + ## @brief Stop parsing at a specific position + ## @param[in] self Class handle + ## @param[in] list_of_element List of element that stop the parsing + ## + def set_stop_at(self, list_of_element): + self._list_element_stop = list_of_element + + ## + ## @brief get the last element parsed. + ## @param[in] self Class handle + ## + def get_last_parsed(self): + return self._last_element_parsed + + ## + ## @brief Display help on console output + ## @param[in] self Class handle + ## @param[in] action_name opation to set at the end of the application name + ## + def display(self, action_name=""): + print("usage:") + listOfPropertiesArg = ""; + for element in self.list_properties : + listOfPropertiesArg += element.get_porperties() + print(" " + sys.argv[0] + " " + action_name + " " + listOfPropertiesArg + " ...") + for element in self.list_properties : + element.display() + diff --git a/death/__init__.py b/death/__init__.py new file mode 100755 index 0000000..f04f5f7 --- /dev/null +++ b/death/__init__.py @@ -0,0 +1,14 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## + + + +# nothing to do. + diff --git a/pylintRcFile.txt b/pylintRcFile.txt new file mode 100644 index 0000000..407cb89 --- /dev/null +++ b/pylintRcFile.txt @@ -0,0 +1,411 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code +extension-pkg-whitelist= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. The +# regex matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. +jobs=1 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Specify a configuration file. +#rcfile= + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once).You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use"--disable=all --enable=classes +# --disable=W" +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable= + + +[REPORTS] + +# Python expression which should return a note less than 10 (10 is the highest +# note). You have access to the variables errors warning, statement which +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio).You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +class-name-hint=[A-Z_][a-zA-Z0-9]+$ + +# Regular expression matching correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +#no-docstring-rgx=^_ +no-docstring-rgx=^ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[SPELLING] + +# Spelling dictionary name. Available dictionaries: none. To make it working +# install python-enchant package. +spelling-dict= + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to indicated private dictionary in +# --spelling-private-dict-file option instead of raising a message. +spelling-store-unknown-words=no + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string='\t' + +# Maximum number of characters on a single line. +max-line-length=200 + +# Maximum number of lines in a module +max-module-lines=3000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# mixin class is detected if its name ends with "mixin" (case insensitive). +ignore-mixin-members=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis. It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME,XXX,TODO + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.* + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[IMPORTS] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub,TERMIOS,Bastion,rexec + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..e69de29 diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..34ae02d --- /dev/null +++ b/setup.py @@ -0,0 +1,46 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +## +## @author Edouard DUPIN +## +## @copyright 2012, Edouard DUPIN, all right reserved +## +## @license MPL v2.0 (see license file) +## + +from setuptools import setup + +def readme(): + with open('README.rst') as f: + return f.read() + +# https://pypi.python.org/pypi?%3Aaction=list_classifiers +setup(name='death', + version='1.0.0', + description='Dapth is a simple argument parser tool to get the cmdline argumets', + long_description=readme(), + url='http://github.com/HeeroYui/death', + author='Edouard DUPIN', + author_email='yui.heero@gmail.com', + license='MPL-2', + packages=['death'], + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)', + 'Programming Language :: Python', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + keywords='log logs debug print console', + include_package_data = True, + zip_safe=False) + +#To developp: sudo ./setup.py install +# sudo ./setup.py develop +#pylint test: pylint2 --rcfile=pylintRcFile.txt death/debug.py + +#TO register all in pip: use external tools: +# pip install twine +# # create the archive +# ./setup.py sdist +# twine upload dist/* +