Skip to content

Commit

Permalink
code conventions and import fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
loechel committed Jul 20, 2017
1 parent 9e475c1 commit 87d6255
Show file tree
Hide file tree
Showing 6 changed files with 141 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@
/src/plone.api.egg-info/
/var/
pip-selfcheck.json
/.tox/
/_build/
/reports/
11 changes: 11 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,14 @@ force_single_line=True
lines_after_imports=2
line_length=200
not_skip=__init__.py

[coverage:run]
branch = True
source = src
omit =

[coverage:report]
precision = 2

[coverage:html]
directory = reports/coverage
2 changes: 2 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# -*- coding: utf-8 -*-

from setuptools import find_packages
from setuptools import setup

Expand All @@ -8,6 +9,7 @@
def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read()


long_description = \
read('README.rst') + '\n\n' + \
read('CHANGES.rst') + '\n\n' + \
Expand Down
2 changes: 1 addition & 1 deletion src/plone/api/portal.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ def show_message(message=None, request=None, type='info'):
:param message: [required] Message to show.
:type message: string
:param request: [required] Request.
:type request: TODO: hm?
:type request: TODO: hm? # NOQA: T000
:param type: Message type. Possible values: 'info', 'warn', 'error'
:type type: string
:raises:
Expand Down
2 changes: 1 addition & 1 deletion src/plone/api/tests/test_user.py
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ def test_get_roles_no_parameters(self):

def test_get_permissions_no_parameters(self):
"""Test get_permissions passing no parameters."""
self.assertEqual( # TODO: maybe assertItemsEqual?
self.assertEqual( # TODO: maybe assertItemsEqual? # NOQA: T000
set(p[0] for p in getPermissions()),
set(api.user.get_permissions().keys())
)
Expand Down
123 changes: 123 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
[tox]
envlist =
py27-Plone-{4.3,5.0,5.1},
isort,
flake8,
docs,
coverage-report,

skip_missing_interpreters = false

[testenv]
skip_install = True

basepython:
py27: python2.7

extras =
test

Plone-4.3:
commands =
mkdir -p {toxinidir}/reports/coverage
{envbindir}/buildout -c {toxinidir}/plone-4.3.x.cfg buildout:directory={envdir} buildout:develop={toxinidir} bootstrap
{envbindir}/buildout -c {toxinidir}/plone-4.3.x.cfg buildout:directory={envdir} buildout:develop={toxinidir}
coverage run {envbindir}/test -v1 --auto-color {posargs}
Plone-5.0:
commands =
mkdir -p {toxinidir}/reports/coverage
{envbindir}/buildout -c {toxinidir}/plone-5.0.x.cfg buildout:directory={envdir} buildout:develop={toxinidir} bootstrap
{envbindir}/buildout -c {toxinidir}/plone-5.0.x.cfg buildout:directory={envdir} buildout:develop={toxinidir}
coverage run {envbindir}/test -v1 --auto-color {posargs}
Plone-5.1:
commands =
mkdir -p {toxinidir}/reports/coverage
{envbindir}/buildout -c {toxinidir}/plone-5.1.x.cfg buildout:directory={envdir} buildout:develop={toxinidir} bootstrap
{envbindir}/buildout -c {toxinidir}/plone-5.1.x.cfg buildout:directory={envdir} buildout:develop={toxinidir}
coverage run {envbindir}/test -v1 --auto-color {posargs}

setenv =
COVERAGE_FILE=.coverage.{envname}

deps =
pdbpp
setuptools==33.1.1
zc.buildout==2.8.0
coverage

whitelist_externals =
mkdir

[testenv:coverage-report]
basepython = python2.7
deps = coverage

setenv =
COVERAGE_FILE=.coverage

skip_install = true

commands =
coverage erase
coverage combine
coverage report
coverage html
coverage xml

[testenv:flake8]
basepython = python2.7
skip_install = true

deps =
flake8
flake8-html
flake8-coding
flake8-debugger
flake8-deprecated
flake8-isort
flake8-pep3101
flake8-plone-hasattr
flake8-polyfill
flake8-print
flake8-quotes
flake8-string-format
flake8-todo

commands =
mkdir -p {toxinidir}/reports/flake8
- flake8 --format=html --htmldir={toxinidir}/reports/flake8 src setup.py
flake8 src setup.py

whitelist_externals =
mkdir

[testenv:isort]
basepython = python2.7
skip_install = true

deps =
isort

commands =
isort --check-only --recursive {toxinidir}/src

[testenv:isort-apply]
basepython = python2.7
skip_install = true

deps =
isort

commands =
isort --apply --recursive {toxinidir}/src


[testenv:docs]
basepython = python2.7
skip_install = false

deps =
Sphinx

commands =
sphinx-build -b html -d _build/docs/doctrees docs _build/docs/html

1 comment on commit 87d6255

@jenkins-plone-org
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@loechel Jenkins CI reporting about code analysis
See the full report here: http://jenkins.plone.org/job/package-plone.api/20/violations

src/plone/api/tests/test_portal.py:4:1: I001 isort found an import in the wrong position

Follow these instructions to reproduce it locally.

Please sign in to comment.