Merge branch 'release-3.2' into release

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt

CHANGELOG.rst

@@ -3,6 +3,16 @@ Change Log
 ==========
 
 
+3.2
+===
+
+Added
+-----
+
+* Option ``--file-var-root`` to render file variables (``_FILE_``,
+  ``_THIS_FILE``) as relative paths with respect to a specified root.
+
+
 3.1
 ===
 
@@ -22,11 +32,7 @@ Changed
 
 * Support for Python 2.7, 3.3 and 3.4 dropped, support for Python 3.9 added.
 
-
-Fixed
------
-
-
+
 3.0
 ===
 

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2021 Bálint Aradi, Universität Bremen
+Copyright (c) 2016-2023 Bálint Aradi, Universität Bremen
 
 All rights reserved.
 

README.rst

@@ -170,21 +170,52 @@ Main features
 Installing
 ==========
 
-Fypp needs a working Python interpreter. It is compatible with Python 2 (version
-2.6 and above) and Python 3 (all versions).
+Fypp needs a working Python 3 interpreter (Python 3.5 or above).
 
-Automatic install
------------------
+When you install Fypp, you obtain the command line tool ``fypp`` and the Python
+module ``fypp.py``. Latter you can import if you want to access the
+functionality of Fypp directly from within your Python scripts.
 
-Use Pythons command line installer ``pip`` in order to download the stable
-release from the `Fypp page on PyPI <http://pypi.python.org/pypi/fypp>`_ and
-install it on your system::
 
-  pip install fypp
+Installing via conda
+--------------------
 
-This installs both, the command line tool ``fypp`` and the Python module
-``fypp.py``. Latter you can import if you want to access the functionality of
-Fypp directly from within your Python scripts.
+The last stable release of Fypp can be easily installed as conda package by
+issuing ::
+
+  conda install -c conda-forge fypp
+
+
+Installing via pip
+------------------
+
+You can also use Pythons command line installer ``pip`` in order to download the
+stable release from the `Fypp page on PyPI <http://pypi.python.org/pypi/fypp>`_
+and install it on your system.
+
+If you want to install Fypp into the module system of the active Python 3
+interpreter (typically the case when you are using a Python virtual
+environment), issue ::
+
+  pip3 install fypp
+
+Alternatively, you can install Fypp into the user space (under `~/.local`) with
+::
+
+  pip3 install --user fypp
+
+
+Installing via MSYS2 pacman
+---------------------------
+
+On Windows you can use the `MSYS2 toolchain <https://www.msys2.org/>`_ to install
+Fypp in a MinGW terminal. To install Fypp use::
+
+  pacman -S mingw-w64-x86_64-python-fypp
+
+Make sure the selected architecture is matching your current MinGW terminal.
+For all supporting MinGW architectures visit check the package index
+`here <https://packages.msys2.org/base/mingw-w64-python-fypp>`_.
 
 
 Manual install

bin/fypp

@@ -4,7 +4,7 @@
 #
 # fypp -- Python powered Fortran preprocessor
 #
-# Copyright (c) 2016-2021 Bálint Aradi, Universität Bremen
+# Copyright (c) 2016-2023 Bálint Aradi, Universität Bremen
 #
 # All rights reserved.
 #
@@ -50,7 +50,7 @@ subclasses of `FyppError`_ is raised:
 * FyppStopRequest: Stop was triggered by an explicit request in the input
   (by a stop- or an assert-directive).
 '''
-
+import pathlib
 import sys
 import types
 import inspect
@@ -66,7 +66,7 @@ import builtins
 # Prevent cluttering user directory with Python bytecode
 sys.dont_write_bytecode = True
 
-VERSION = '3.1'
+VERSION = '3.2'
 
 STDIN = '<stdin>'
 
@@ -1323,10 +1323,12 @@ class Renderer:
             Format 'std' emits #line pragmas, 'cpp' resembles GNU cpps special
             format, and 'gfortran5' adds to cpp a workaround for a bug introduced in GFortran 5.
         linefolder (callable): Callable to use when folding a line.
+        filevarroot (str, optional): render _FILE_ and _THIS_FILE_ as paths relative to this
+            root directory (default: paths are not converted explicitely to relative paths)
     '''
 
     def __init__(self, evaluator=None, linenums=False, contlinenums=False,
-                 linenumformat=None, linefolder=None):
+                 linenumformat=None, linefolder=None, filevarroot=None):
         # Evaluator to use for Python expressions
         self._evaluator = Evaluator() if evaluator is None else evaluator
         self._evaluator.updateglobals(_SYSTEM_=platform.system(),
@@ -1360,6 +1362,13 @@ class Renderer:
         else:
             self._linefolder = linefolder
 
+        if filevarroot is None:
+            self._convert_file_path = lambda path: path
+        else:
+            self._convert_file_path = (
+                lambda path: pathlib.Path(path).relative_to(filevarroot)
+            )
+
 
     def render(self, tree, divert=False, fixposition=False):
         '''Renders a tree.
@@ -1739,6 +1748,7 @@ class Renderer:
 
 
     def _update_predef_globals(self, fname, linenr):
+        fname = self._convert_file_path(fname)
         self._evaluator.updatelocals(
             _DATE_=time.strftime('%Y-%m-%d'), _TIME_=time.strftime('%H:%M:%S'),
             _THIS_FILE_=fname, _THIS_LINE_=linenr + 1)
@@ -2528,7 +2538,8 @@ class Fypp:
         if inspect.signature(renderer_factory) == inspect.signature(Renderer):
             renderer = renderer_factory(
                 evaluator, linenums=linenums, contlinenums=contlinenums,
-                linenumformat=options.line_marker_format, linefolder=linefolder)
+                linenumformat=options.line_marker_format, linefolder=linefolder,
+                filevarroot=options.file_var_root)
         else:
             raise FyppFatalError('renderer_factory has incorrect signature')
         self._preprocessor = Processor(parser, builder, renderer)
@@ -2579,7 +2590,7 @@ class Fypp:
     @staticmethod
     def _apply_definitions(defines, evaluator):
         for define in defines:
-            words = define.split('=', 2)
+            words = define.split('=', 1)
             name = words[0]
             value = None
             if len(words) > 1:
@@ -2673,6 +2684,7 @@ class FyppOptions(optparse.Values):
         self.fixed_format = False
         self.encoding = 'utf-8'
         self.create_parent_folder = False
+        self.file_var_root = None
 
 
 class FortranLineFolder:
@@ -2893,6 +2905,12 @@ def get_option_parser():
                       dest='create_parent_folder',
                       default=defs.create_parent_folder, help=msg)
 
+    msg = 'in variables _FILE_ and _THIS_FILE_, use relative paths with DIR '\
+          'as root directory. Note: the input file and all included files '\
+          'must be in DIR or in a directory below.'
+    parser.add_option('--file-var-root', metavar='DIR', dest='file_var_root',
+                      default=defs.file_var_root, help=msg)
+
     return parser
 
 

docs/conf.py

@@ -46,24 +46,24 @@
 
 # General information about the project.
 project = 'Fypp'
-copyright = '2016-2021, Bálint Aradi'
+copyright = '2016-2023, Bálint Aradi'
 author = 'Bálint Aradi'
 
 # 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 = '3.1'
+version = '3.2'
 # The full version, including alpha/beta/rc tags.
-release = '3.1'
+release = '3.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.