Skip to content

Commit

Permalink
Merge pull request #6 from SpiNNakerManchester/pep8
Browse files Browse the repository at this point in the history 
pep8
  • Loading branch information
@dkfellows
dkfellows committed May 31, 2017
2 parents d4dc468 + 910ef18 commit eecc429
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 73 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ script:
--cov tests \
--durations=10
# Code quality check
- flake8 spalloc tests
- flake8
after_success:
- coveralls
notifications:
Expand Down
128 changes: 64 additions & 64 deletions docs/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@
# modules for mocks.
import sys
from mock import Mock as MagicMock
import inspect
import spalloc
import os
from spalloc import __version__ as version


class Mock(MagicMock):
@classmethod
def __getattr__(cls, name):
return Mock()


MOCK_MODULES = ['pygtk', 'gtk', 'gobject', 'argparse', 'numpy', 'pandas']
for mod_name in MOCK_MODULES:
try:
Expand All @@ -34,8 +40,6 @@ def __getattr__(cls, name):
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys # noqa
import os # noqa

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand All @@ -46,7 +50,7 @@ def __getattr__(cls, name):
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand All @@ -70,7 +74,7 @@ def __getattr__(cls, name):
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
Expand All @@ -87,66 +91,62 @@ def __getattr__(cls, name):
# built documents.
#
# The short X.Y version.
from spalloc import __version__ as version
# The full version, including alpha/beta/rc tags.
release = version

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# keep_warnings = False

# Search Python docs for extra definitions.
intersphinx_mapping = {'python': ('http://docs.python.org/3', None),
'rig': ('http://rig.readthedocs.org/en/stable/', None)
}
}

# -- linkcode GitHub link generator ---------------------------------------

import inspect

import spalloc

local_module_path = spalloc.__file__
github_module_path = "spalloc/"
github_repo = "SpiNNakerManchester/spalloc"


def linkcode_resolve(domain, info):
"""Determine the URL corresponding to Python object on GitHub
This code is derived from the version used by `Numpy
<https://github.com/numpy/numpy/blob/v1.9.2/doc/source/conf.py#L286>`_.
"""
Expand Down Expand Up @@ -178,7 +178,8 @@ def linkcode_resolve(domain, info):
return None

# Convert the filename into a path relative to the spalloc module top-level
file_name = os.path.relpath(file_name, start=os.path.dirname(local_module_path))
file_name = os.path.relpath(file_name,
start=os.path.dirname(local_module_path))

# Get the line number range that object lives on
try:
Expand All @@ -190,15 +191,14 @@ def linkcode_resolve(domain, info):
lineno + len(source) - 1)
else:
linespec = ""

# Generate a link to the code in the official GitHub repository with the
# current-version's tag.
return ("https://github.com/{repo}/blob/v{version}/"
"{module_path}{file_name}{linespec}".format(repo=github_repo,
version=version,
module_path=github_module_path,
file_name=file_name,
linespec=linespec))
"{module_path}{file_name}{linespec}"
"".format(repo=github_repo, version=version,
module_path=github_module_path, file_name=file_name,
linespec=linespec))


# -- Options for HTML output ----------------------------------------------
Expand All @@ -210,26 +210,26 @@ def linkcode_resolve(domain, info):
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -239,56 +239,56 @@ def linkcode_resolve(domain, info):
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'spalloc_doc'


# -- Options for LaTeX output ---------------------------------------------

#latex_elements = {
# latex_elements = {
# # The paper size ('letterpaper' or 'a4paper').
# #'papersize': 'letterpaper',
#
Expand All @@ -297,70 +297,70 @@ def linkcode_resolve(domain, info):
#
# # Additional stuff for the LaTeX preamble.
# #'preamble': '',
#}
# }

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
#latex_documents = [
# latex_documents = [
# ('index', 'Rig.tex', u'Rig Documentation',
# AUTHORS, 'manual'),
#]
# ]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
#man_pages = [
# man_pages = [
# ('index', 'rig', u'Rig Documentation',
# [AUTHORS], 1)
#]
# ]

# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
#texinfo_documents = [
# texinfo_documents = [
# ('index', 'Rig', u'Rig Documentation',
# AUTHORS, 'Rig',
# 'Tools for mapping problems to SpiNNaker',
# 'Miscellaneous'),
#]
# ]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# texinfo_no_detailmenu = False
14 changes: 10 additions & 4 deletions setup.py
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
from setuptools import setup, find_packages

with open("spalloc/version.py", "r") as f:
exec(f.read())
__version__ = None
exec(open("spalloc/version.py").read())
assert __version__

setup(
name="spalloc",
Expand All @@ -11,7 +12,8 @@
# Metadata for PyPi
url="https://github.com/SpiNNakerManchester/spalloc",
author="Jonathan Heathcote",
description="A client for the spalloc_server SpiNNaker machine partitioning and allocation system.",
description="A client for the spalloc_server SpiNNaker machine "
"partitioning and allocation system.",
license="GPLv2",
classifiers=[
"Development Status :: 3 - Alpha",
Expand All @@ -34,7 +36,11 @@
keywords="spinnaker allocation packing management supercomputer",

# Requirements
install_requires=["six>=1.8.0", "appdirs", "enum-compat", "pytz", "tzlocal"],
install_requires=["six>=1.8.0",
"appdirs",
"enum-compat",
"pytz",
"tzlocal"],

# Scripts
entry_points={
Expand Down

0 comments on commit eecc429

Please sign in to comment.