Merge branch 'release/v1.8.2'

Author: MicBoucinha

.bumpversion.cfg

@@ -0,0 +1,17 @@
+[bumpversion]
+current_version = 1.8.2
+commit = False
+tag = False
+
+[bumpversion:file:setup.py]
+search = current_version = "{current_version}"
+replace = current_version = "{new_version}"
+
+[bumpversion:file:docs/source/conf.py]
+search = version = release = "{current_version}"
+replace = version = release = "{new_version}"
+
+[bumpversion:file:pybpodapi/__init__.py]
+search = __version__ = "{current_version}"
+replace = __version__ = "{new_version}"
+

docs/source/conf.py

@@ -24,15 +24,14 @@
 import os
 import sys
 
-#sys.path.insert(0, os.path.abspath('../../pybpodapi'))
-#sys.path.insert(0, os.path.abspath('../../'))
-
-import pybpodapi
+# sys.path.insert(0, os.path.abspath('../../pybpodapi'))
+# sys.path.insert(0, os.path.abspath('../../'))
 
 # adds support for Markwdown
 from recommonmark.parser import CommonMarkParser
+
 source_parsers = {
-	'.md': CommonMarkParser,
+    ".md": CommonMarkParser,
 }
 
 
@@ -46,45 +45,44 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-	'sphinx.ext.autodoc',
-	'sphinx.ext.intersphinx',
-	'sphinx.ext.todo',
-	'sphinx.ext.viewcode',
-	'sphinx.ext.inheritance_diagram']
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.inheritance_diagram",
+]
 
 
-graphviz_output_format = 'svg'
+graphviz_output_format = "svg"
 
 # Do not sort autodoc alphabetically, use source code appearance order.
-autodoc_member_order= 'bysource'
+autodoc_member_order = "bysource"
 
 # Both the class’ and the __init__ method’s docstring are concatenated and inserted.
-autoclass_content = 'both'
+autoclass_content = "both"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = 'pybpod-api'
-copyright = '2017-2019, CF Scientific Software Platform'
-author = 'Carlos Mão de Ferro'
+project = "pybpod-api"
+copyright = "2017-2019, Scientific Software Platform, Champalimaud Foundation"
+author = "Scientific Software Platform, Champalimaud Foundation"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = pybpodapi.__version__
-# The full version, including alpha/beta/rc tags.
-release = pybpodapi.__version__
+version = release = "1.8.2"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -99,7 +97,7 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'default'
+pygments_style = "default"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
@@ -110,7 +108,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # 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
@@ -119,60 +117,59 @@
 # html_theme_options = {}
 # toc tree depth on sidebar
 html_theme_options = {
-	'collapse_navigation': False,
-	'display_version': True,
-	'navigation_depth': 3
+    "collapse_navigation": False,
+    "display_version": True,
+    "navigation_depth": 3,
 }
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_images']
+html_static_path = ["_images"]
 
 
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pybpodapidoc'
+htmlhelp_basename = "pybpodapidoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-	# The paper size ('letterpaper' or 'a4paper').
-	#
-	# 'papersize': 'letterpaper',
-
-	# The font size ('10pt', '11pt' or '12pt').
-	#
-	# 'pointsize': '10pt',
-
-	# Additional stuff for the LaTeX preamble.
-	#
-	# 'preamble': '',
-
-	# Latex figure (float) alignment
-	#
-	# 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # 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 = [
-	(master_doc, 'pybpodapi.tex', 'pybpod-api Documentation',
-	 'Carlos Mão de Ferro', 'manual'),
+    (
+        master_doc,
+        "pybpodapi.tex",
+        "pybpod-api Documentation",
+        "Carlos Mão de Ferro",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-	(master_doc, 'pybpodapi', 'pybpod-api Documentation',
-	 [author], 1)
-]
+man_pages = [(master_doc, "pybpodapi", "pybpod-api Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -181,13 +178,18 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-	(master_doc, 'pybpodapi', 'pybpod-api Documentation',
-	 author, 'pybpodapi', 'One line description of project.',
-	 'Miscellaneous'),
+    (
+        master_doc,
+        "pybpodapi",
+        "pybpod-api Documentation",
+        author,
+        "pybpodapi",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
-
 # -- Options for Epub output ----------------------------------------------
 
 # Bibliographic Dublin Core info.
@@ -206,9 +208,9 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
-
+epub_exclude_files = ["search.html"]
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'python': ('https://docs.python.org/3.5', None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3.5", None)}
+

pybpodapi/__init__.py

@@ -3,27 +3,45 @@
 from confapp import conf
 import loggingbootstrap
 
-__version__ = "1.8.1"
-__author__ = ['Ricardo Ribeiro', 'Carlos Mão de Ferro', 'Joshua Sanders', 'Luís Teixeira']
-__credits__ = ["Ricardo Ribeiro", "Carlos Mao de Ferro", 'Luís Teixeira']
+__version__ = "1.8.2"
+__author__ = [
+    "Ricardo Ribeiro",
+    "Carlos Mão de Ferro",
+    "Joshua Sanders",
+    "Luís Teixeira",
+]
+__credits__ = ["Ricardo Ribeiro", "Carlos Mao de Ferro", "Luís Teixeira"]
 __license__ = "MIT"
-__maintainer__ = ['Ricardo Ribeiro', 'Carlos Mão de Ferro', 'Joshua Sanders', 'Luís Teixeira']
-__email__ = ['ricardojvr@gmail.com', 'cajomferro@gmail.com', 'joshua21@gmail.com', 'micboucinha@gmail.com']
+__maintainer__ = [
+    "Ricardo Ribeiro",
+    "Carlos Mão de Ferro",
+    "Joshua Sanders",
+    "Luís Teixeira",
+]
+__email__ = [
+    "ricardojvr@gmail.com",
+    "cajomferro@gmail.com",
+    "joshua21@gmail.com",
+    "micboucinha@gmail.com",
+]
 __status__ = "Development"
 
 
 # load the user settings
 try:
     import user_settings
+
     conf += user_settings
 except:
     pass
 
-conf += 'pybpodapi.settings'
+conf += "pybpodapi.settings"
 
 if conf.PYBPOD_API_LOG_LEVEL is not None:
     # setup different loggers for example script and api
-    loggingbootstrap.create_double_logger("pybpodapi",
-                                          conf.PYBPOD_API_LOG_LEVEL,
-                                          conf.PYBPOD_API_LOG_FILE,
-                                          conf.PYBPOD_API_LOG_LEVEL)
+    loggingbootstrap.create_double_logger(
+        "pybpodapi",
+        conf.PYBPOD_API_LOG_LEVEL,
+        conf.PYBPOD_API_LOG_FILE,
+        conf.PYBPOD_API_LOG_LEVEL,
+    )

pybpodapi/bpod/bpod_base.py

@@ -234,7 +234,7 @@ def send_state_machine(self, sma, run_asap=None):
 
         state_machine_body = sma.build_message() + sma.build_message_global_timer() + sma.build_message_32_bits()
 
-        self._bpodcom_send_state_machine( sma.build_header(run_asap, len(state_machine_body)) + state_machine_body)
+        self._bpodcom_send_state_machine(sma.build_header(run_asap, len(state_machine_body)) + state_machine_body)
 
         self._new_sma_sent = True
 
@@ -332,10 +332,7 @@ def run_state_machine(self, sma):
             self.close()
             exit(0)
 
-        if interrupt_task:
-            return False
-
-        return True
+        return not interrupt_task
 
     def handle_inline(self, inline, sma):
         interrupt_task = False
@@ -425,7 +422,7 @@ def trigger_input(self, channel_number, value):
     def trigger_output(self, channel_number, value):
         return self._bpodcom_override_digital_hardware_state(channel_number, value)
 
-    def trigger_softcode(self, softcode): 
+    def trigger_softcode(self, softcode):
         return self._bpodcom_send_softcode(softcode)
 
     def load_message(self, module_index, msg):

pybpodapi/bpod/bpod_com_protocol.py

@@ -252,7 +252,6 @@ def _bpodcom_enable_ports(self, hardware):
 
         ###### set inputs enabled or disabled #######################################################
         hardware.inputs_enabled = [0] * len(hardware.inputs)
-        ports_found = False
 
         for j, i in enumerate(hardware.bnc_inputports_indexes):
             hardware.inputs_enabled[i] = settings.BPOD_BNC_PORTS_ENABLED[j]
@@ -615,6 +614,6 @@ def modules(self):
     #   return BpodBase.machine_type.fget(self)
 
     # @property
-    # def cycle_frequency(self): 
+    # def cycle_frequency(self):
     #   self.__bpodcom_check_com_ready()
     #   return BpodBase.cycle_frequency.fget(self)