From cff1f2a627816e3812c2aab2a082f77eaa3132c0 Mon Sep 17 00:00:00 2001 From: Jacques Joubert Date: Wed, 13 Feb 2019 21:45:07 +0200 Subject: [PATCH] Added package structure --- .pycodestyle | 2 + .pylintrc | 268 +++++++++++++++++++++++++++ .travis.yml | 13 ++ mlfinlab/__init__.py | 3 + mlfinlab/data_structures/__init__.py | 0 mlfinlab/data_structures/code.py | 8 + mlfinlab/tests/__init__.py | 0 mlfinlab/tests/tests.py | 19 ++ pylint | 2 + requirements.txt | 3 + scripts/run_tests.py | 5 + 11 files changed, 323 insertions(+) create mode 100644 .pycodestyle create mode 100644 .pylintrc create mode 100644 .travis.yml create mode 100644 mlfinlab/__init__.py create mode 100644 mlfinlab/data_structures/__init__.py create mode 100644 mlfinlab/data_structures/code.py create mode 100644 mlfinlab/tests/__init__.py create mode 100644 mlfinlab/tests/tests.py create mode 100755 pylint create mode 100644 requirements.txt create mode 100644 scripts/run_tests.py diff --git a/.pycodestyle b/.pycodestyle new file mode 100644 index 000000000..20633ed5f --- /dev/null +++ b/.pycodestyle @@ -0,0 +1,2 @@ +[pycodestyle] +max-line-length=160 diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 000000000..4974dfb5d --- /dev/null +++ b/.pylintrc @@ -0,0 +1,268 @@ +[MASTER] + +# Specify a configuration file. +#rcfile= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Add files or directories to the blacklist. They should be base names, not +# paths. +ignore=CVS,flume + +# Pickle collected data for later comparisons. +persistent=yes + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + + +[MESSAGES CONTROL] + +# 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. See also the "--disable" option for examples. +#enable= + +# 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". +# +# Reference: http://pylint-messages.wikidot.com/all-codes +disable=I, + maybe-no-member, + star-args, + abstract-class-not-used, + duplicate-code, + superfluous-parens, + abstract-class-little-used, + too-few-public-methods + +# Notes: +# abstract-class-not-used: see http://www.logilab.org/ticket/111138 + + +[REPORTS] + +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html. You can also give a reporter class, eg +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Put messages in a separate file for each module / package specified on the +# command line instead of printing them on stdout. Reports (if any) will be +# written in a file name "pylint_global.[txt|html]". +files-output=no + +# Tells whether to display a full report or only the messages +reports=yes + +# 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 massage information. See doc for all details +# +# Reference: http://docs.pylint.org/output.html +msg-template={C}:{line:3d},{column:2d}: [{obj}] {msg} ({msg_id} - {symbol}) + +[BASIC] + +# List of builtins function names that should not be used, separated by a comma +bad-functions=map,filter,apply,input + +# Regular expression which should only match correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression which should only match correct module level names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression which should only match correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ + +# Regular expression which should only match correct function names +function-rgx=[a-z_][a-z0-9_]{2,40}$ + +# Regular expression which should only match correct method names +method-rgx=[a-z_][a-z0-9_]{2,40}$ + +# Regular expression which should only match correct instance attribute names +attr-rgx=[a-z_][a-z0-9_]{2,40}$ + +# Regular expression which should only match correct argument names +argument-rgx=[a-z_][a-z0-9_]{2,40}$ + +# Regular expression which should only match correct variable names +variable-rgx=[a-z_][a-z0-9_]{2,40}$ + +# Regular expression which should only match correct attribute names in class +# bodies +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,40}|(__.*__))$ + +# Regular expression which should only match correct list comprehension / +# generator expression variable names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=__.*__ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=160 + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Maximum number of lines in a module +max-module-lines=1000 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME,XXX + + +[SIMILARITIES] + +# Minimum lines number of a similarity. +min-similarity-lines=5 + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + + +[TYPECHECK] + +# 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 classes names for which member attributes should not be checked +# (useful for classes with attributes dynamically set). +ignored-classes=SQLObject + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E0201 when accessed. Python regular +# expressions are accepted. +generated-members=REQUEST,acl_users,aq_parent + + +[VARIABLES] + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching the beginning of the name of dummy variables +# (i.e. not used). +dummy-variables-rgx=_$|dummy + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# 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=10 + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.* + +# Maximum number of locals for function / method body +max-locals=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of statements in function / method body +max-statements=50 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of attributes for a class (see R0902). +max-attributes=10 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub,TERMIOS,Bastion,rexec + +# 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 external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 000000000..b3f855d11 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +language: python +python: + - "3.6.6" +# command to install dependencies +install: + - pip install -r requirements.txt +# Enabling the quiet flag can be useful if you’re trying to avoid log file size limit +git: + quiet: true +# command to run tests +script: + - python -m unittest discover + - \ No newline at end of file diff --git a/mlfinlab/__init__.py b/mlfinlab/__init__.py new file mode 100644 index 000000000..8a0670fd1 --- /dev/null +++ b/mlfinlab/__init__.py @@ -0,0 +1,3 @@ +""" +This is the test package. +""" diff --git a/mlfinlab/data_structures/__init__.py b/mlfinlab/data_structures/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/mlfinlab/data_structures/code.py b/mlfinlab/data_structures/code.py new file mode 100644 index 000000000..402e73b9b --- /dev/null +++ b/mlfinlab/data_structures/code.py @@ -0,0 +1,8 @@ + + +def addition(num1, num2): + return num1 + num2 + + +def subtraction(num1, num2): + return num1 - num2 diff --git a/mlfinlab/tests/__init__.py b/mlfinlab/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/mlfinlab/tests/tests.py b/mlfinlab/tests/tests.py new file mode 100644 index 000000000..694f58a2b --- /dev/null +++ b/mlfinlab/tests/tests.py @@ -0,0 +1,19 @@ +import unittest +import mlfinlab.data_structures.code as code + + +class TestFunctions(unittest.TestCase): + + def test_addition(self): + answer = 1 + 2 + self.assertTrue(answer == code.addition(1, 2)) + + def test_subtraction(self): + + answer = 1 - 2 + self.assertTrue(answer == code.subtraction(1, 2)) + + def test_fail(self): + + answer = 1 + 2 + self.assertFalse(answer == code.subtraction(1, 2)) diff --git a/pylint b/pylint new file mode 100755 index 000000000..f38579406 --- /dev/null +++ b/pylint @@ -0,0 +1,2 @@ +#!/bin/bash +pylint mlfinlab --rcfile=.pylintrc -f text diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 000000000..b3b1cfdc2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +pandas==0.23.4 +numpy==1.15.4 +xmlrunner==1.7.7 \ No newline at end of file diff --git a/scripts/run_tests.py b/scripts/run_tests.py new file mode 100644 index 000000000..688b2abb3 --- /dev/null +++ b/scripts/run_tests.py @@ -0,0 +1,5 @@ +import unittest +import xmlrunner + +if __name__ == '__main__': + unittest.main(testRunner=xmlrunner.XMLTestRunner(output='test_reports'), module=None)