From a544549a812fe610bfd0b2877752a15bd427963e Mon Sep 17 00:00:00 2001 From: Cayo Puigdefabregas Date: Thu, 24 Nov 2022 12:21:42 +0100 Subject: [PATCH] clean --- docs/conf.py | 42 +++++++++++++++++------------ ereuse_devicehub/config.py | 3 +-- ereuse_devicehub/dummy/dummy.py | 3 +-- ereuse_devicehub/parser/computer.py | 4 +-- 4 files changed, 29 insertions(+), 23 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index a1b4e42e..73d3ccc9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,6 @@ from teal.enums import Country, Currency, Layouts, Subdivision from teal.marshmallow import EnumField from ereuse_devicehub.marshmallow import NestedOn -from ereuse_devicehub.resources.schemas import Thing project = 'Devicehub' copyright = '2020, eReuse.org team' @@ -56,7 +55,7 @@ extensions = [ 'sphinx.ext.viewcode', 'sphinxcontrib.plantuml', 'sphinx.ext.autosectionlabel', - 'sphinx.ext.autodoc' + 'sphinx.ext.autodoc', ] # Add any paths that contain templates here, relative to this directory. @@ -126,15 +125,12 @@ 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', @@ -144,18 +140,20 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'Devicehub.tex', 'Devicehub Documentation', - 'eReuse.org team', 'manual'), + ( + master_doc, + 'Devicehub.tex', + 'Devicehub Documentation', + 'eReuse.org team', + '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, 'devicehub', 'Devicehub Documentation', - [author], 1) -] +man_pages = [(master_doc, 'devicehub', 'Devicehub Documentation', [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -163,9 +161,15 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Devicehub', 'Devicehub Documentation', - author, 'Devicehub', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + 'Devicehub', + 'Devicehub Documentation', + author, + 'Devicehub', + 'One line description of project.', + 'Miscellaneous', + ), ] # -- Extension configuration ------------------------------------------------- @@ -199,6 +203,7 @@ class DhlistDirective(Directive): This requires :py:class:`ereuse_devicehub.resources.schemas.SchemaMeta`. You will find in that module more information. """ + has_content = False # Definition of passed-in options @@ -216,7 +221,7 @@ class DhlistDirective(Directive): sections = [] sections.append(self.links(things)) # Make index - for thng in things: # type: Thing + for thng in things: # Generate a section for each class, with a title, # fields description and a paragraph section = n.section(ids=[self._id(thng)]) @@ -228,7 +233,9 @@ class DhlistDirective(Directive): for key, f in thng._own: name = n.field_name(text=f.data_key or key) body = [ - self.parse('{} {}'.format(self.type(f), f.metadata.get('description', ''))) + self.parse( + '{} {}'.format(self.type(f), f.metadata.get('description', '')) + ) ] if isinstance(f, EnumField): body.append(self._parse_enum_field(f)) @@ -244,6 +251,7 @@ class DhlistDirective(Directive): def _parse_enum_field(self, f): from ereuse_devicehub.resources.device import states + if issubclass(f.enum, (Subdivision, Currency, Country, Layouts, states.State)): return self.parse(f.enum.__doc__) else: @@ -298,7 +306,7 @@ class DhlistDirective(Directive): def parse(self, text) -> n.container: """Parses text possibly containing ReST stuff and adds it in - a node.""" + a node.""" p = n.container('') self.state.nested_parse(StringList(string2lines(inspect.cleandoc(text))), 0, p) return p diff --git a/ereuse_devicehub/config.py b/ereuse_devicehub/config.py index 79a9b75b..a41c9640 100644 --- a/ereuse_devicehub/config.py +++ b/ereuse_devicehub/config.py @@ -1,6 +1,5 @@ from distutils.version import StrictVersion from itertools import chain -from typing import Set from decouple import config from teal.auth import TokenAuth @@ -44,7 +43,7 @@ class DevicehubConfig(Config): import_resource(metric_def), ), ) - PASSWORD_SCHEMES = {'pbkdf2_sha256'} # type: Set[str] + PASSWORD_SCHEMES = {'pbkdf2_sha256'} SECRET_KEY = config('SECRET_KEY') DB_USER = config('DB_USER', 'dhub') DB_PASSWORD = config('DB_PASSWORD', 'ereuse') diff --git a/ereuse_devicehub/dummy/dummy.py b/ereuse_devicehub/dummy/dummy.py index 7947a85b..ee7f7c15 100644 --- a/ereuse_devicehub/dummy/dummy.py +++ b/ereuse_devicehub/dummy/dummy.py @@ -1,7 +1,6 @@ import itertools import json from pathlib import Path -from typing import Set import click import click_spinner @@ -109,7 +108,7 @@ class Dummy: files = tuple(Path(__file__).parent.joinpath('files').iterdir()) print('done.') sample_pc = None # We treat this one as a special sample for demonstrations - pcs = set() # type: Set[int] + pcs = set() with click.progressbar(files, label='Creating devices...'.ljust(28)) as bar: for path in bar: with path.open() as f: diff --git a/ereuse_devicehub/parser/computer.py b/ereuse_devicehub/parser/computer.py index afd2e17d..b41ce833 100644 --- a/ereuse_devicehub/parser/computer.py +++ b/ereuse_devicehub/parser/computer.py @@ -4,7 +4,7 @@ from contextlib import suppress from datetime import datetime from fractions import Fraction from math import hypot -from typing import Iterator, List, Optional, Type, TypeVar +from typing import Iterator, List, Optional, TypeVar import dateutil.parser from ereuse_utils import getter, text @@ -404,7 +404,7 @@ class Computer(Device): chassis value. """ - COMPONENTS = list(Component.__subclasses__()) # type: List[Type[Component]] + COMPONENTS = list(Component.__subclasses__()) COMPONENTS.remove(Motherboard) def __init__(self, node: dict) -> None: