From ed0579f7844082ad0caeb0665ef64558f958f2b5 Mon Sep 17 00:00:00 2001 From: Sebb Date: Thu, 15 Jun 2023 16:26:51 +0100 Subject: [PATCH 1/8] Fix up metadata classes 'date' processing is now done by process_metadata This fixes #62 --- plugins/gfm.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/gfm.py b/plugins/gfm.py index 07ec49b..c002ee4 100644 --- a/plugins/gfm.py +++ b/plugins/gfm.py @@ -165,8 +165,8 @@ def read_source(self, source_path): name = match.group(1).strip().lower() if name != 'slug': value = match.group(2).strip() - if name == 'date': - value = pelican.utils.get_date(value) + # Ensure the correct types are used + value = self.process_metadata(name, value) metadata[name] = value #if name != 'title': # print 'META:', name, value From 511f25bbe39a250f20bad2a6b02efaf8ebf2aafe Mon Sep 17 00:00:00 2001 From: Sebb Date: Fri, 16 Jun 2023 15:27:37 +0100 Subject: [PATCH 2/8] Sync with default --- .github/workflows/linting.yml | 40 +++ mypy.ini | 5 + pylintrc | 578 ++++++++++++++++++++++++++++++++++ 3 files changed, 623 insertions(+) create mode 100644 .github/workflows/linting.yml create mode 100644 mypy.ini create mode 100644 pylintrc diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml new file mode 100644 index 0000000..fbcf249 --- /dev/null +++ b/.github/workflows/linting.yml @@ -0,0 +1,40 @@ +name: Linting and MyPy +on: + push: + workflow_dispatch: + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.10", 3.8] + steps: + - uses: actions/checkout@master + with: + persist-credentials: false + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install mypy + pip install types-PyYAML + pip install types-requests + pip install types-beautifulsoup4 + pip install pylint + pip list + - name: Type testing with mypy + run: | + mypy --cache-dir /tmp/ --install-types + mypy --cache-dir /tmp/ --ignore-missing-imports bin/*.py plugins/*.py + - name: Testing with pylint + run: | + pylint bin/*.py plugins/*.py diff --git a/mypy.ini b/mypy.ini new file mode 100644 index 0000000..a7c8178 --- /dev/null +++ b/mypy.ini @@ -0,0 +1,5 @@ +[mypy-ezt.*] +ignore_missing_imports = True + +[mypy-pelican.*] +ignore_missing_imports = True \ No newline at end of file diff --git a/pylintrc b/pylintrc new file mode 100644 index 0000000..0c5d350 --- /dev/null +++ b/pylintrc @@ -0,0 +1,578 @@ +[MASTER] + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list=fcntl,unicodedata + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold to be exceeded before program exits with error. +fail-under=10.0 + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the ignore-list. The +# regex matches against paths and can be in Posix or Windows format. +ignore-paths= + +# Files or directories matching the regex patterns are skipped. The regex +# matches against base names, not paths. +ignore-patterns= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.10 + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. +confidence= + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then reenable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + attribute-defined-outside-init, + logging-fstring-interpolation, # Not essential + C,R, + R0903,R0913,R0912,R0914,R0915, + R1706, # ternary + W1406, # redundant u-string prefix + W0105, # String statement has no effect (pointless-string-statement) + W0511, # TODO etc + W0707, # Consider explicitly re-raising using the 'from' keyword (raise-missing-from) + W1514, # Using open without explicitly specifying an encoding (unspecified-encoding) + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'error', 'warning', 'refactor', and 'convention' +# which contain the number of messages in each category, as well as 'statement' +# which is the total number of statements analyzed. This score is used by the +# global evaluation report (RP0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +#msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear and the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +# notes=FIXME, +# XXX, +# TODO + +# Regular expression of note tags to take in consideration. +#notes-rgx= + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether missing members accessed in mixin class should be ignored. A +# class is considered mixin if its name matches the mixin-class-rgx option. +ignore-mixin-members=yes + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins ignore-mixin- +# members is set to 'yes' +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=no + +# Signatures are removed from the similarity computation +ignore-signatures=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. +#variable-rgx= + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=cls + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "BaseException, Exception". +overgeneral-exceptions=builtins.BaseException, + builtins.Exception From a4e005a56b10167016489557ba99840f33579ae4 Mon Sep 17 00:00:00 2001 From: Sebb Date: Fri, 16 Jun 2023 16:05:44 +0100 Subject: [PATCH 3/8] Attempt to test the issue --- .github/workflows/issue62.yml | 40 ++++++++++++++++++++ tests/compare_meta.sh | 6 +++ tests/content/one.md | 11 ++++++ tests/def/one.html | 12 ++++++ tests/gfm/one.html | 12 ++++++ tests/pelican.def.py | 48 ++++++++++++++++++++++++ tests/pelican.gfm.py | 48 ++++++++++++++++++++++++ tests/themes/trivial/templates/base.html | 8 ++++ 8 files changed, 185 insertions(+) create mode 100644 .github/workflows/issue62.yml create mode 100755 tests/compare_meta.sh create mode 100644 tests/content/one.md create mode 100644 tests/def/one.html create mode 100644 tests/gfm/one.html create mode 100644 tests/pelican.def.py create mode 100644 tests/pelican.gfm.py create mode 100644 tests/themes/trivial/templates/base.html diff --git a/.github/workflows/issue62.yml b/.github/workflows/issue62.yml new file mode 100644 index 0000000..dacc54d --- /dev/null +++ b/.github/workflows/issue62.yml @@ -0,0 +1,40 @@ +name: Unit test issue62 - correct metadata types +on: + push: + paths: + - '**/issue62.yml' + + workflow_dispatch: + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.10", 3.8] + steps: + - uses: actions/checkout@master + with: + persist-credentials: false + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Build GFM + run: | + bin/build-cmark.sh | grep LIBCMARKDIR > libcmark.sh + - name: Run test + run: | + source libcmark.sh + export + pwd + cd tests + compare_meta.sh diff --git a/tests/compare_meta.sh b/tests/compare_meta.sh new file mode 100755 index 0000000..f9f7b50 --- /dev/null +++ b/tests/compare_meta.sh @@ -0,0 +1,6 @@ +echo Running GFM +pelican content --settings pelican.gfm.py -d --o gfm +echo Running default Markdown +pelican content --settings pelican.def.py -d --o def +rm def/sitemap.txt # not needed +diff -r gfm def diff --git a/tests/content/one.md b/tests/content/one.md new file mode 100644 index 0000000..3d3e507 --- /dev/null +++ b/tests/content/one.md @@ -0,0 +1,11 @@ +title: Test file one +tags: abc;def,ghi +author: Writer1 +xyz: 456 +date: 2023-01-10 +modified: 2022 10 01 11:23 + + +first + +second diff --git a/tests/def/one.html b/tests/def/one.html new file mode 100644 index 0000000..f092452 --- /dev/null +++ b/tests/def/one.html @@ -0,0 +1,12 @@ +metadata: + category misc + path_no_ext one + title Test file one + tags [, ] + author Writer1 + xyz 456 + date 2023-01-10 00:00:00 + modified 2022-10-01 11:23:00 + +content:

first

+

second

\ No newline at end of file diff --git a/tests/gfm/one.html b/tests/gfm/one.html new file mode 100644 index 0000000..f092452 --- /dev/null +++ b/tests/gfm/one.html @@ -0,0 +1,12 @@ +metadata: + category misc + path_no_ext one + title Test file one + tags [, ] + author Writer1 + xyz 456 + date 2023-01-10 00:00:00 + modified 2022-10-01 11:23:00 + +content:

first

+

second

\ No newline at end of file diff --git a/tests/pelican.def.py b/tests/pelican.def.py new file mode 100644 index 0000000..4fff1e6 --- /dev/null +++ b/tests/pelican.def.py @@ -0,0 +1,48 @@ +SITEMAP = {} +# Basic information about the site. +SITENAME = 'Apache Template' +SITEDESC = 'Provides a template for projects wishing to use the Pelican ASF static content system' +SITEDOMAIN = 'template.apache.org' +SITEURL = 'https://template.apache.org' +SITELOGO = 'https://template.apache.org/images/logo.png' +SITEREPOSITORY = 'https://github.com/apache/template-site/blob/main/content/' +CURRENTYEAR = 2023 +TRADEMARKS = 'Apache, the Apache feather logo, and "Project" are trademarks or registered trademarks' +TIMEZONE = 'UTC' +# Theme includes templates and possibly static files +THEME = 'themes/trivial' +# Specify location of plugins, and which to use +# All content is located at '.' (aka content/ ) +PAGE_PATHS = [ '.' ] +STATIC_PATHS = [ '.', ] +# Where to place/link generated pages + +PATH_METADATA = '(?P.*)\\..*' + +PAGE_SAVE_AS = '{path_no_ext}.html' +# Don't try to translate +PAGE_TRANSLATION_ID = None +# Disable unused Pelican features +# N.B. These features are currently unsupported, see https://github.com/apache/infrastructure-pelican/issues/49 +FEED_ALL_ATOM = None +INDEX_SAVE_AS = '' +TAGS_SAVE_AS = '' +CATEGORIES_SAVE_AS = '' +AUTHORS_SAVE_AS = '' +ARCHIVES_SAVE_AS = '' +# Disable articles by pointing to a (should-be-absent) subdir +ARTICLE_PATHS = [ 'blog' ] +# needed to create blogs page +ARTICLE_URL = 'blog/{slug}.html' +ARTICLE_SAVE_AS = 'blog/{slug}.html' +# Disable all processing of .html files +READERS = { 'html': None, } +# TODO: find out how to disable the sitemap +SITEMAP = {'format': 'txt'} + + + + + + + diff --git a/tests/pelican.gfm.py b/tests/pelican.gfm.py new file mode 100644 index 0000000..64302db --- /dev/null +++ b/tests/pelican.gfm.py @@ -0,0 +1,48 @@ + +# Basic information about the site. +SITENAME = 'Apache Template' +SITEDESC = 'Provides a template for projects wishing to use the Pelican ASF static content system' +SITEDOMAIN = 'template.apache.org' +SITEURL = 'https://template.apache.org' +SITELOGO = 'https://template.apache.org/images/logo.png' +SITEREPOSITORY = 'https://github.com/apache/template-site/blob/main/content/' +CURRENTYEAR = 2023 +TRADEMARKS = 'Apache, the Apache feather logo, and "Project" are trademarks or registered trademarks' +TIMEZONE = 'UTC' +# Theme includes templates and possibly static files +THEME = 'themes/trivial' +# Specify location of plugins, and which to use +PLUGIN_PATHS = [ '../plugins', ] +PLUGINS = [ 'gfm', ] +# All content is located at '.' (aka content/ ) +PAGE_PATHS = [ '.' ] +STATIC_PATHS = [ '.', ] +# Where to place/link generated pages + +PATH_METADATA = '(?P.*)\\..*' + +PAGE_SAVE_AS = '{path_no_ext}.html' +# Don't try to translate +PAGE_TRANSLATION_ID = None +# Disable unused Pelican features +# N.B. These features are currently unsupported, see https://github.com/apache/infrastructure-pelican/issues/49 +FEED_ALL_ATOM = None +INDEX_SAVE_AS = '' +TAGS_SAVE_AS = '' +CATEGORIES_SAVE_AS = '' +AUTHORS_SAVE_AS = '' +ARCHIVES_SAVE_AS = '' +# Disable articles by pointing to a (should-be-absent) subdir +ARTICLE_PATHS = [ 'blog' ] +# needed to create blogs page +ARTICLE_URL = 'blog/{slug}.html' +ARTICLE_SAVE_AS = 'blog/{slug}.html' +# Disable all processing of .html files +READERS = { 'html': None, } + + + + + + + diff --git a/tests/themes/trivial/templates/base.html b/tests/themes/trivial/templates/base.html new file mode 100644 index 0000000..16c5fe6 --- /dev/null +++ b/tests/themes/trivial/templates/base.html @@ -0,0 +1,8 @@ +metadata: +{% for name, value in page.metadata.items() %} + {% if name != 'slug' and name != 'reader' %} + {{ name }} {{ value }} {{ value.__class__}} + {% endif %} +{% endfor %} + +content: {{ page.content.rstrip() }} From 69aebfd5eca0f50987abf39c80bf6f5abea36962 Mon Sep 17 00:00:00 2001 From: Sebb Date: Fri, 16 Jun 2023 16:37:19 +0100 Subject: [PATCH 4/8] Fix path to script --- .github/workflows/issue62.yml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/workflows/issue62.yml b/.github/workflows/issue62.yml index dacc54d..8f3ad82 100644 --- a/.github/workflows/issue62.yml +++ b/.github/workflows/issue62.yml @@ -34,7 +34,5 @@ jobs: - name: Run test run: | source libcmark.sh - export - pwd cd tests - compare_meta.sh + ./compare_meta.sh From f26f5cda8009debdae6ec41a68d21c3c47874338 Mon Sep 17 00:00:00 2001 From: Sebb Date: Fri, 16 Jun 2023 16:40:19 +0100 Subject: [PATCH 5/8] Some debug --- .github/workflows/issue62.yml | 2 +- tests/compare_meta.sh | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/issue62.yml b/.github/workflows/issue62.yml index 8f3ad82..b0b1a2a 100644 --- a/.github/workflows/issue62.yml +++ b/.github/workflows/issue62.yml @@ -13,7 +13,7 @@ jobs: test: runs-on: ubuntu-latest strategy: - fail-fast: false + fail-fast: true matrix: python-version: ["3.10", 3.8] steps: diff --git a/tests/compare_meta.sh b/tests/compare_meta.sh index f9f7b50..56df7ab 100755 --- a/tests/compare_meta.sh +++ b/tests/compare_meta.sh @@ -1,6 +1,6 @@ echo Running GFM -pelican content --settings pelican.gfm.py -d --o gfm +pelican content --settings pelican.gfm.py -dD --o gfm echo Running default Markdown -pelican content --settings pelican.def.py -d --o def +pelican content --settings pelican.def.py -dD --o def rm def/sitemap.txt # not needed diff -r gfm def From 56dd9e33e76e6bba66db92d431001f3b0cf9139f Mon Sep 17 00:00:00 2001 From: Sebb Date: Fri, 16 Jun 2023 21:58:28 +0100 Subject: [PATCH 6/8] Fixes --- .github/workflows/issue62.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/issue62.yml b/.github/workflows/issue62.yml index b0b1a2a..eb2b446 100644 --- a/.github/workflows/issue62.yml +++ b/.github/workflows/issue62.yml @@ -21,12 +21,13 @@ jobs: with: persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip + pip install pelican[Markdown]==4.5.4 pip install -r requirements.txt - name: Build GFM run: | From 232d4250721d3bddd0c1547a2cf4c10d78892526 Mon Sep 17 00:00:00 2001 From: Sebb Date: Fri, 16 Jun 2023 22:51:46 +0100 Subject: [PATCH 7/8] Sync with master --- .github/workflows/linting.yml | 4 ++-- plugins/asfdata.py | 4 ++-- plugins/asfgenid.py | 2 +- plugins/toc.py | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index fbcf249..6af8e96 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -10,7 +10,7 @@ jobs: test: runs-on: ubuntu-latest strategy: - fail-fast: false + fail-fast: true matrix: python-version: ["3.10", 3.8] steps: @@ -18,7 +18,7 @@ jobs: with: persist-credentials: false - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies diff --git a/plugins/asfdata.py b/plugins/asfdata.py index 1b25b7b..f5fbc5d 100644 --- a/plugins/asfdata.py +++ b/plugins/asfdata.py @@ -342,9 +342,9 @@ def process_sequence(metadata, seq, sequence, load, debug): if save_metadata: metadata[seq] = reference try: - metadata[f'{seq}_size'] = len(reference) + metadata[f'{seq}_size'] = len(reference) except TypeError: # allow for integer - pass + pass # create metadata sequences and dictionaries from a data load diff --git a/plugins/asfgenid.py b/plugins/asfgenid.py index f15d0ef..05b1a79 100644 --- a/plugins/asfgenid.py +++ b/plugins/asfgenid.py @@ -283,7 +283,7 @@ def make_breadcrumbs(rel_source_path, title): parts = rel_source_path.split('/') url = '/' crumbs = [] - crumbs.append(f'Home » ') + crumbs.append('Home » ') # don't process the filename part last = len(parts)-1 for i in range(last): diff --git a/plugins/toc.py b/plugins/toc.py index 887076c..81bac44 100644 --- a/plugins/toc.py +++ b/plugins/toc.py @@ -122,7 +122,7 @@ def generate_toc(content): header_re = re.compile(content.metadata.get( 'toc_headers', content.settings['TOC']['TOC_HEADERS'])) except re.error as e: - logger.error("TOC_HEADERS '%s' is not a valid re\n%s", + logger.error("TOC_HEADERS '%s' is not a valid re\n", content.settings['TOC']['TOC_HEADERS']) raise e From e2e1fa318896dc85908d00e85de0023e55f3bd49 Mon Sep 17 00:00:00 2001 From: Sebb Date: Sat, 17 Jun 2023 21:47:04 +0100 Subject: [PATCH 8/8] Don't load default plugins (e.g. sitemap) --- tests/compare_meta.sh | 1 - tests/pelican.def.py | 4 +--- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/tests/compare_meta.sh b/tests/compare_meta.sh index 56df7ab..8420936 100755 --- a/tests/compare_meta.sh +++ b/tests/compare_meta.sh @@ -2,5 +2,4 @@ echo Running GFM pelican content --settings pelican.gfm.py -dD --o gfm echo Running default Markdown pelican content --settings pelican.def.py -dD --o def -rm def/sitemap.txt # not needed diff -r gfm def diff --git a/tests/pelican.def.py b/tests/pelican.def.py index 4fff1e6..708a680 100644 --- a/tests/pelican.def.py +++ b/tests/pelican.def.py @@ -1,4 +1,3 @@ -SITEMAP = {} # Basic information about the site. SITENAME = 'Apache Template' SITEDESC = 'Provides a template for projects wishing to use the Pelican ASF static content system' @@ -12,6 +11,7 @@ # Theme includes templates and possibly static files THEME = 'themes/trivial' # Specify location of plugins, and which to use +PLUGINS = [] # don't autoload any plugins # All content is located at '.' (aka content/ ) PAGE_PATHS = [ '.' ] STATIC_PATHS = [ '.', ] @@ -37,8 +37,6 @@ ARTICLE_SAVE_AS = 'blog/{slug}.html' # Disable all processing of .html files READERS = { 'html': None, } -# TODO: find out how to disable the sitemap -SITEMAP = {'format': 'txt'}