Black is now used to format Python code and ruff to lint Python code.

Author: anthony-tuininga

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 23.9.1
+    hooks:
+    -   id: black
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.291
+    hooks:
+    -   id: ruff

README.txt

@@ -2,4 +2,3 @@ Please see the python-oracledb home page for links to documentation,
 installation instructions, and source code:
 
 https://oracle.github.io/python-oracledb/index.html
-

THIRD_PARTY_LICENSES.txt

@@ -453,4 +453,3 @@ GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-

doc/src/_ext/oracle_deprecated.py

@@ -1,5 +1,5 @@
-#------------------------------------------------------------------------------
-# Copyright (c) 2022, Oracle and/or its affiliates.
+# -----------------------------------------------------------------------------
+# Copyright (c) 2022, 2023, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
 # (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -20,20 +20,21 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-#------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
-#------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # oracle_deprecated.py
 #
-# Overrides the 'deprecated' directive so that it can a componment name can be
-# used in conjunction with the version.
-#------------------------------------------------------------------------------
+# Overrides the 'deprecated' directive so that a componment name can be used in
+# conjunction with the version.
+# -----------------------------------------------------------------------------
 
 
 from docutils import nodes
 from docutils.parsers.rst import Directive
 from sphinx import addnodes
 
+
 class DriverDeprecated(Directive):
     has_content = True
     required_arguments = 1
@@ -43,22 +44,22 @@ class DriverDeprecated(Directive):
     def run(self):
         node = addnodes.versionmodified()
         node.document = self.state.document
-        node['type'] = self.name
-        node['version'] = self.arguments[0]
-        text = 'Deprecated since {}.'.format(self.arguments[0])
-        classes = ['versionmodified', 'deprecated']
-        para = nodes.paragraph('', '',
-                               nodes.inline('', text, classes=classes),
-                               translatable=False)
+        node["type"] = self.name
+        node["version"] = self.arguments[0]
+        text = "Deprecated since {}.".format(self.arguments[0])
+        classes = ["versionmodified", "deprecated"]
+        para = nodes.paragraph(
+            "", "", nodes.inline("", text, classes=classes), translatable=False
+        )
         node.append(para)
-        ret: List[Node] = [node]
-        return ret
+        return [node]
+
 
 def setup(app):
     app.add_directive("deprecated", DriverDeprecated, override=True)
 
     return {
-        'version': '0.1',
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
+        "version": "0.1",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
     }

doc/src/_ext/table_with_summary.py

@@ -1,4 +1,4 @@
-#------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # Copyright (c) 2022, Oracle and/or its affiliates.
 #
 # This software is dual-licensed to you under the Universal Permissive License
@@ -20,59 +20,59 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-#------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
-#------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 # table_with_summary.py
 #
 # Defines a directive (list-table-with-summary) that adds support for a summary
 # option on top of the regular "list-table" directive.
-#------------------------------------------------------------------------------
+# -----------------------------------------------------------------------------
 
 import sphinx
 from docutils.parsers.rst import directives
 from docutils.parsers.rst.directives import tables
 
 from packaging import version
 
-class ListTableWithSummary(tables.ListTable):
 
-    option_spec = {'summary': directives.unchanged}
+class ListTableWithSummary(tables.ListTable):
+    option_spec = {"summary": directives.unchanged}
     option_spec.update(tables.ListTable.option_spec)
 
     def run(self):
         result = super().run()
-        summary = self.options.get('summary')
+        summary = self.options.get("summary")
         if summary:
             table_node = result[0]
             table_node["summary"] = summary
         return result
 
 
 class HTMLTranslator(sphinx.writers.html5.HTML5Translator):
-
     def visit_table(self, node):
-        if version.parse(sphinx.__version__) > version.parse('4.2.0'):
+        if version.parse(sphinx.__version__) > version.parse("4.2.0"):
             self._table_row_indices = [0]
         else:
             self._table_row_index = 0
 
         atts = {}
-        classes = [cls.strip(' \t\n') \
-                for cls in self.settings.table_style.split(',')]
+        classes = [
+            cls.strip(" \t\n") for cls in self.settings.table_style.split(",")
+        ]
         classes.insert(0, "docutils")  # compat
 
         # set align-default if align not specified to give a default style
-        classes.append('align-%s' % node.get('align', 'default'))
+        classes.append("align-%s" % node.get("align", "default"))
 
-        if 'width' in node:
-            atts['style'] = 'width: %s' % node['width']
-        if 'summary' in node:
-            atts['summary'] = node['summary']
-        tag = self.starttag(node, 'table', CLASS=' '.join(classes), **atts)
+        if "width" in node:
+            atts["style"] = "width: %s" % node["width"]
+        if "summary" in node:
+            atts["summary"] = node["summary"]
+        tag = self.starttag(node, "table", CLASS=" ".join(classes), **atts)
         self.body.append(tag)
 
 
 def setup(app):
-    app.add_directive('list-table-with-summary', ListTableWithSummary)
+    app.add_directive("list-table-with-summary", ListTableWithSummary)
     app.set_translator("html", HTMLTranslator, override=True)

doc/src/conf.py

@@ -2,10 +2,11 @@
 #
 # python-oracledb documentation build configuration file
 #
-# This file is execfile()d with the current directory set to its containing dir.
+# This file is execfile()d with the current directory set to its containing dir
 #
 # The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed automatically).
+# that aren't pickleable (module imports are okay, they're removed
+# automatically).
 #
 # All configuration values have a default value; values that are commented out
 # serve to show the default value.
@@ -19,23 +20,28 @@
 # General configuration
 # ---------------------
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["table_with_summary", "oracle_deprecated", 'sphinx_rtd_theme']
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ["table_with_summary", "oracle_deprecated", "sphinx_rtd_theme"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = [".templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The root toctree document.
-root_doc = master_doc = 'index'
+root_doc = master_doc = "index"
 
 # General substitutions.
-project = 'python-oracledb'
-copyright = u'2016, 2023, Oracle and/or its affiliates. All rights reserved. Portions Copyright © 2007-2015, Anthony Tuininga. All rights reserved. Portions Copyright © 2001-2007, Computronix (Canada) Ltd., Edmonton, Alberta, Canada. All rights reserved'
-author = 'Oracle'
+project = "python-oracledb"
+copyright = (
+    "2016, 2023, Oracle and/or its affiliates. All rights reserved. "
+    "Portions Copyright © 2007-2015, Anthony Tuininga. All rights reserved. "
+    "Portions Copyright © 2001-2007, Computronix (Canada) Ltd., "
+    "Edmonton, Alberta, Canada. All rights reserved"
+)
+author = "Oracle"
 
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
@@ -56,26 +62,26 @@
 
 # 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 documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
 
 # 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
+# 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'
+pygments_style = "sphinx"
 
 
 # Options for HTML output
@@ -87,64 +93,67 @@
 # html_style = 'default.css'
 
 # The theme to use for readthedocs.
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # 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 = ['.static']
+html_static_path = [".static"]
 
 # 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
 
 # Content template for the index page.
-#html_index = ''
+# html_index = ''
 
 # 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_use_modindex = True
+# html_use_modindex = True
 
 # If true, the reST sources are included in the HTML build as _sources/<name>.
 html_copy_source = False
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'oracledbdoc'
+htmlhelp_basename = "oracledbdoc"
 
 numfig = True
 
+
 # Display tables with no horizontal scrollbar
 def setup(app):
-    app.add_css_file('custom.css')
+    app.add_css_file("custom.css")
+
 
 # Options for LaTeX output
 # ------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, document class [howto/manual]).
-#latex_documents = []
+# (source start file, target name, title, author, document class
+# [howto/manual]).
+# latex_documents = []
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_use_modindex = True
+# latex_use_modindex = True

doc/src/release_notes.rst

@@ -36,6 +36,7 @@ Common Changes
     Client 23c is also required.
 #)  Added support for parsing the ``FAILOVER`` clause in full connect
     descriptors.
+#)  Black is now used to format Python code and ruff to lint Python code.
 
 
 oracledb 1.4.1 (September 2023)

pyproject.toml

@@ -1,3 +1,13 @@
 [build-system]
 requires = ["setuptools >= 40.6.0", "wheel", "cython"]
 build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 79
+target-version = ["py37", "py38", "py39", "py310", "py311", "py312"]
+required-version = 23
+
+[tool.ruff]
+line-length = 79
+target-version = "py38"
+exclude = ["templates"]