Commit 3a96a4f5 authored by dboe's avatar dboe
Browse files

Update template

parent 2961c4db
Pipeline #83962 passed with stage
in 36 seconds
......@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
......@@ -12,7 +12,8 @@ GITSTATUS = $(shell git status --porcelain)
part ?= patch
test: FORCE
flake8 rna tests
flake8 tfields tests
pylint tfields tests
py.test
coverage:
......
......@@ -8,4 +8,3 @@ API Documentation
{% for docname in docnames %}
{{ docname }}
{%- endfor %}
......@@ -4,4 +4,4 @@ Usage
To use tfields in a project::
>>> import tfields
\ No newline at end of file
>>> import tfields
......@@ -13,7 +13,7 @@ search = version='{current_version}'
replace = {new_version}
[bumpversion:file:docs/cookiecutter_input.json]
search = "package_version": "{current_version}"
search = 'package_version': '{current_version}'
replace = {new_version}
[metadata]
......@@ -71,6 +71,7 @@ docs =
sphinx_rtd_theme>=0.4.3
test =
flake8
pylint
pytest
pytest-cov
coverage
......@@ -88,14 +89,14 @@ exclude_lines =
pragma: no cover
if False
[coverage:run]
omit =
tfields/plotting/*.py
[flake8]
max-line-length = 99
doctests = True
exclude = .git, .eggs, __pycache__, docs, dist, venv, .tox
ignore = E203 W503 W504 # wrong flake defaults: see https://github.com/psf/black/issues/315, https://github.com/psf/black/issues/43
[pylint.]
ignore = setup.py
[build_sphinx]
builder = html,man
......@@ -113,6 +114,7 @@ skip_missing_interpreters = true
envlist =
py{35,36,37,38}
recreate = true
usedevelop = true
[gh-actions]
python =
......@@ -131,7 +133,6 @@ commands =
pytest \
--cov={[metadata]name} \
--ignore=docs \
--ignore=tfields/plotting \
--junitxml=report/junit.xml
[testenv:flake8]
......
from setuptools import setup
setup(version='0.3.2')
setup(version="0.3.2")
......@@ -3,9 +3,10 @@
"""Tests for `tfields` package."""
import unittest
import tfields
class Test_tfields(unittest.TestCase):
class TestPackage(unittest.TestCase):
"""Tests for `tfields` package."""
def setUp(self):
......@@ -16,5 +17,5 @@ class Test_tfields(unittest.TestCase):
def test_version_type(self):
"""Assure that version type is str."""
import tfields
self.assertIsInstance(tfields.__version__, str)
......@@ -8,49 +8,64 @@ import tfields
class SomeAction(argparse.Action):
"""Some actions."""
def __init__(self, option_strings, dest, nargs=None, **kwargs):
if nargs is not None:
raise ValueError("nargs not allowed")
super().__init__(option_strings, dest, **kwargs)
def __call__(self, parser, namespace, values, option_string=None):
print("Example action invoked by manage in namespace: %r with values %r"
" and option string %r" % (namespace, values, option_string))
print(
"Example action invoked by manage in namespace: %r with values %r"
" and option string %r" % (namespace, values, option_string)
)
setattr(namespace, self.dest, values)
def showcase_dummy(self):
"""
You can define a method to expose functionality of the class
"""
print(self)
def manage(args):
def manage(args_):
"""Example function."""
print("Managing!")
print(args.x * args.y)
print(args_.x * args_.y)
def parse_args(args):
def parse_args(args_):
"""Parse args."""
# create the top-level parser
parser = argparse.ArgumentParser(prog='tfields app')
parser.add_argument('--version', action='version',
version='v' + tfields.__version__,
help="Show program's version number and exit")
parser = argparse.ArgumentParser(prog='tfields app')
parser = argparse.ArgumentParser(prog="tfields app")
parser.add_argument(
"--version",
action="version",
version="v" + tfields.__version__,
help="Show program's version number and exit",
)
parser = argparse.ArgumentParser(prog="tfields app")
# subparsers
subparsers = parser.add_subparsers(help='sub-command help')
subparsers = parser.add_subparsers(help="sub-command help")
# create the parser for the "test" command
example_sub_parser = subparsers.add_parser('manage', help='manage something')
example_sub_parser.add_argument('-x', type=int, default=1)
example_sub_parser.add_argument('-y', type=float, default=42.)
example_sub_parser = subparsers.add_parser("manage", help="manage something")
example_sub_parser.add_argument("-x", type=int, default=1)
example_sub_parser.add_argument("-y", type=float, default=42.0)
example_sub_parser.set_defaults(func=manage)
# If no arguments were used, print base-level help with possible commands.
if len(args) == 0:
if len(args_) == 0:
parser.print_help(file=sys.stderr)
sys.exit(1)
args = parser.parse_args(args)
args_ = parser.parse_args(args_)
# let argparse do the job of calling the appropriate function after
# argument parsing is complete
args.func(args)
return args_.func(args_)
if __name__ == '__main__':
args = parse_args(sys.argv[1:])
if __name__ == "__main__":
_ = parse_args(sys.argv[1:])
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment