diff --git a/.gitattributes b/.gitattributes
index cf1d397cc804845fd5e0cb169f1f55fe2c75ac06..bf9b89066319c3f3849e378a851894412651d2dd 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -1 +1 @@
-pystencils/_version.py export-subst
+src/pystencils/_version.py export-subst
diff --git a/pyproject.toml b/pyproject.toml
index 5ef106e59e61780f49518cc33c6fc0dd21daf853..df005bfdb1bb91fe94a33308fa97046082c09102 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -12,7 +12,7 @@ authors = [
]
license = { file = "COPYING.txt" }
requires-python = ">=3.10"
-dependencies = ["sympy>=1.6,<=1.11.1", "numpy>=1.8.0", "appdirs", "joblib", "pyyaml"]
+dependencies = ["sympy>=1.9,<=1.12.1", "numpy>=1.8.0", "appdirs", "joblib", "pyyaml"]
classifiers = [
"Development Status :: 4 - Beta",
"Framework :: Jupyter",
@@ -71,8 +71,7 @@ tests = [
[build-system]
requires = [
"setuptools>=61",
- "versioneer>=0.29",
- "tomli; python_version < '3.11'",
+ "versioneer[toml]>=0.29",
# 'Cython'
]
build-backend = "setuptools.build_meta"
diff --git a/src/pystencils/__init__.py b/src/pystencils/__init__.py
index c39cd3b826c733da9dceb1944f0cce5038c348e0..1761c88f0e69c06f30935007d187a3af947c900f 100644
--- a/src/pystencils/__init__.py
+++ b/src/pystencils/__init__.py
@@ -15,7 +15,7 @@ from .config import (
OpenMpConfig,
)
from .kernel_decorator import kernel, kernel_config
-from .kernelcreation import create_kernel
+from .kernelcreation import create_kernel, create_staggered_kernel
from .backend.kernelfunction import KernelFunction
from .slicing import make_slice
from .spatial_coordinates import (
@@ -28,12 +28,13 @@ from .spatial_coordinates import (
z_,
z_staggered,
)
-from .sympyextensions import Assignment, AssignmentCollection, AddAugmentedAssignment
-from .sympyextensions.astnodes import assignment_from_stencil
+from .assignment import Assignment, AddAugmentedAssignment, assignment_from_stencil
+from .simp import AssignmentCollection
from .sympyextensions.typed_sympy import TypedSymbol
-from .sympyextensions.math import SymbolCreator
+from .sympyextensions import SymbolCreator
from .datahandling import create_data_handling
+
__all__ = [
"Field",
"FieldType",
@@ -48,6 +49,7 @@ __all__ = [
"VectorizationConfig",
"OpenMpConfig",
"create_kernel",
+ "create_staggered_kernel",
"KernelFunction",
"Target",
"show_code",
@@ -75,7 +77,5 @@ __all__ = [
"stencil",
]
-from ._version import get_versions
-
-__version__ = get_versions()["version"]
-del get_versions
+from . import _version
+__version__ = _version.get_versions()['version']
diff --git a/src/pystencils/_version.py b/src/pystencils/_version.py
index 4d216dd5026b7b1e5e7fc4afc1171c8a1dff0fb9..a98e90fc09846c0d7b43929704f6633a0992cdce 100644
--- a/src/pystencils/_version.py
+++ b/src/pystencils/_version.py
@@ -5,8 +5,9 @@
# directories (produced by setup.py build) will contain a much shorter file
# that just contains the computed version number.
-# This file is released into the public domain. Generated by
-# versioneer-0.19 (https://github.com/python-versioneer/python-versioneer)
+# This file is released into the public domain.
+# Generated by versioneer-0.29
+# https://github.com/python-versioneer/python-versioneer
"""Git implementation of _version.py."""
@@ -15,9 +16,11 @@ import os
import re
import subprocess
import sys
+from typing import Any, Callable, Dict, List, Optional, Tuple
+import functools
-def get_keywords():
+def get_keywords() -> Dict[str, str]:
"""Get the keywords needed to look up the version information."""
# these strings will be replaced by git during git-archive.
# setup.py/versioneer.py will grep for the variable names, so they must
@@ -33,8 +36,15 @@ def get_keywords():
class VersioneerConfig:
"""Container for Versioneer configuration parameters."""
+ VCS: str
+ style: str
+ tag_prefix: str
+ parentdir_prefix: str
+ versionfile_source: str
+ verbose: bool
-def get_config():
+
+def get_config() -> VersioneerConfig:
"""Create, populate and return the VersioneerConfig() object."""
# these strings are filled in when 'setup.py versioneer' creates
# _version.py
@@ -43,7 +53,7 @@ def get_config():
cfg.style = "pep440"
cfg.tag_prefix = "release/"
cfg.parentdir_prefix = "pystencils-"
- cfg.versionfile_source = "pystencils/_version.py"
+ cfg.versionfile_source = "src/pystencils/_version.py"
cfg.verbose = False
return cfg
@@ -52,13 +62,13 @@ class NotThisMethod(Exception):
"""Exception raised if a method is not valid for the current scenario."""
-LONG_VERSION_PY = {}
-HANDLERS = {}
+LONG_VERSION_PY: Dict[str, str] = {}
+HANDLERS: Dict[str, Dict[str, Callable]] = {}
-def register_vcs_handler(vcs, method): # decorator
+def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator
"""Create decorator to mark a method as the handler of a VCS."""
- def decorate(f):
+ def decorate(f: Callable) -> Callable:
"""Store f in HANDLERS[vcs][method]."""
if vcs not in HANDLERS:
HANDLERS[vcs] = {}
@@ -67,22 +77,35 @@ def register_vcs_handler(vcs, method): # decorator
return decorate
-def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
- env=None):
+def run_command(
+ commands: List[str],
+ args: List[str],
+ cwd: Optional[str] = None,
+ verbose: bool = False,
+ hide_stderr: bool = False,
+ env: Optional[Dict[str, str]] = None,
+) -> Tuple[Optional[str], Optional[int]]:
"""Call the given command(s)."""
assert isinstance(commands, list)
- p = None
- for c in commands:
+ process = None
+
+ popen_kwargs: Dict[str, Any] = {}
+ if sys.platform == "win32":
+ # This hides the console window if pythonw.exe is used
+ startupinfo = subprocess.STARTUPINFO()
+ startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW
+ popen_kwargs["startupinfo"] = startupinfo
+
+ for command in commands:
try:
- dispcmd = str([c] + args)
+ dispcmd = str([command] + args)
# remember shell=False, so use git.cmd on windows, not just git
- p = subprocess.Popen([c] + args, cwd=cwd, env=env,
- stdout=subprocess.PIPE,
- stderr=(subprocess.PIPE if hide_stderr
- else None))
+ process = subprocess.Popen([command] + args, cwd=cwd, env=env,
+ stdout=subprocess.PIPE,
+ stderr=(subprocess.PIPE if hide_stderr
+ else None), **popen_kwargs)
break
- except EnvironmentError:
- e = sys.exc_info()[1]
+ except OSError as e:
if e.errno == errno.ENOENT:
continue
if verbose:
@@ -93,16 +116,20 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
if verbose:
print("unable to find command, tried %s" % (commands,))
return None, None
- stdout = p.communicate()[0].strip().decode()
- if p.returncode != 0:
+ stdout = process.communicate()[0].strip().decode()
+ if process.returncode != 0:
if verbose:
print("unable to run %s (error)" % dispcmd)
print("stdout was %s" % stdout)
- return None, p.returncode
- return stdout, p.returncode
+ return None, process.returncode
+ return stdout, process.returncode
-def versions_from_parentdir(parentdir_prefix, root, verbose):
+def versions_from_parentdir(
+ parentdir_prefix: str,
+ root: str,
+ verbose: bool,
+) -> Dict[str, Any]:
"""Try to determine the version from the parent directory name.
Source tarballs conventionally unpack into a directory that includes both
@@ -111,15 +138,14 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):
"""
rootdirs = []
- for i in range(3):
+ for _ in range(3):
dirname = os.path.basename(root)
if dirname.startswith(parentdir_prefix):
return {"version": dirname[len(parentdir_prefix):],
"full-revisionid": None,
"dirty": False, "error": None, "date": None}
- else:
- rootdirs.append(root)
- root = os.path.dirname(root) # up a level
+ rootdirs.append(root)
+ root = os.path.dirname(root) # up a level
if verbose:
print("Tried directories %s but none started with prefix %s" %
@@ -128,39 +154,42 @@ def versions_from_parentdir(parentdir_prefix, root, verbose):
@register_vcs_handler("git", "get_keywords")
-def git_get_keywords(versionfile_abs):
+def git_get_keywords(versionfile_abs: str) -> Dict[str, str]:
"""Extract version information from the given file."""
# the code embedded in _version.py can just fetch the value of these
# keywords. When used from setup.py, we don't want to import _version.py,
# so we do it with a regexp instead. This function is not used from
# _version.py.
- keywords = {}
+ keywords: Dict[str, str] = {}
try:
- f = open(versionfile_abs, "r")
- for line in f.readlines():
- if line.strip().startswith("git_refnames ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["refnames"] = mo.group(1)
- if line.strip().startswith("git_full ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["full"] = mo.group(1)
- if line.strip().startswith("git_date ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["date"] = mo.group(1)
- f.close()
- except EnvironmentError:
+ with open(versionfile_abs, "r") as fobj:
+ for line in fobj:
+ if line.strip().startswith("git_refnames ="):
+ mo = re.search(r'=\s*"(.*)"', line)
+ if mo:
+ keywords["refnames"] = mo.group(1)
+ if line.strip().startswith("git_full ="):
+ mo = re.search(r'=\s*"(.*)"', line)
+ if mo:
+ keywords["full"] = mo.group(1)
+ if line.strip().startswith("git_date ="):
+ mo = re.search(r'=\s*"(.*)"', line)
+ if mo:
+ keywords["date"] = mo.group(1)
+ except OSError:
pass
return keywords
@register_vcs_handler("git", "keywords")
-def git_versions_from_keywords(keywords, tag_prefix, verbose):
+def git_versions_from_keywords(
+ keywords: Dict[str, str],
+ tag_prefix: str,
+ verbose: bool,
+) -> Dict[str, Any]:
"""Get version information from git keywords."""
- if not keywords:
- raise NotThisMethod("no keywords at all, weird")
+ if "refnames" not in keywords:
+ raise NotThisMethod("Short version file found")
date = keywords.get("date")
if date is not None:
# Use only the last line. Previous lines may contain GPG signature
@@ -179,11 +208,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
if verbose:
print("keywords are unexpanded, not using")
raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
- refs = set([r.strip() for r in refnames.strip("()").split(",")])
+ refs = {r.strip() for r in refnames.strip("()").split(",")}
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
# just "foo-1.0". If we see a "tag: " prefix, prefer those.
TAG = "tag: "
- tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
+ tags = {r[len(TAG):] for r in refs if r.startswith(TAG)}
if not tags:
# Either we're using git < 1.8.3, or there really are no tags. We use
# a heuristic: assume all version tags have a digit. The old git %d
@@ -192,7 +221,7 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
# between branches and tags. By ignoring refnames without digits, we
# filter out many common branch names like "release" and
# "stabilization", as well as "HEAD" and "master".
- tags = set([r for r in refs if re.search(r'\d', r)])
+ tags = {r for r in refs if re.search(r'\d', r)}
if verbose:
print("discarding '%s', no digits" % ",".join(refs - tags))
if verbose:
@@ -201,6 +230,11 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
# sorting will prefer e.g. "2.0" over "2.0rc1"
if ref.startswith(tag_prefix):
r = ref[len(tag_prefix):]
+ # Filter out refs that exactly match prefix or that don't start
+ # with a number once the prefix is stripped (mostly a concern
+ # when prefix is '')
+ if not re.match(r'\d', r):
+ continue
if verbose:
print("picking %s" % r)
return {"version": r,
@@ -216,7 +250,12 @@ def git_versions_from_keywords(keywords, tag_prefix, verbose):
@register_vcs_handler("git", "pieces_from_vcs")
-def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
+def git_pieces_from_vcs(
+ tag_prefix: str,
+ root: str,
+ verbose: bool,
+ runner: Callable = run_command
+) -> Dict[str, Any]:
"""Get version from 'git describe' in the root of the source tree.
This only gets called if the git-archive 'subst' keywords were *not*
@@ -227,8 +266,15 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
if sys.platform == "win32":
GITS = ["git.cmd", "git.exe"]
- out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root,
- hide_stderr=True)
+ # GIT_DIR can interfere with correct operation of Versioneer.
+ # It may be intended to be passed to the Versioneer-versioned project,
+ # but that should not change where we get our version from.
+ env = os.environ.copy()
+ env.pop("GIT_DIR", None)
+ runner = functools.partial(runner, env=env)
+
+ _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root,
+ hide_stderr=not verbose)
if rc != 0:
if verbose:
print("Directory %s not under git control" % root)
@@ -236,24 +282,57 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
# if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
# if there isn't one, this yields HEX[-dirty] (no NUM)
- describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty",
- "--always", "--long",
- "--match", "%s*" % tag_prefix],
- cwd=root)
+ describe_out, rc = runner(GITS, [
+ "describe", "--tags", "--dirty", "--always", "--long",
+ "--match", f"{tag_prefix}[[:digit:]]*"
+ ], cwd=root)
# --long was added in git-1.5.5
if describe_out is None:
raise NotThisMethod("'git describe' failed")
describe_out = describe_out.strip()
- full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
+ full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root)
if full_out is None:
raise NotThisMethod("'git rev-parse' failed")
full_out = full_out.strip()
- pieces = {}
+ pieces: Dict[str, Any] = {}
pieces["long"] = full_out
pieces["short"] = full_out[:7] # maybe improved later
pieces["error"] = None
+ branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"],
+ cwd=root)
+ # --abbrev-ref was added in git-1.6.3
+ if rc != 0 or branch_name is None:
+ raise NotThisMethod("'git rev-parse --abbrev-ref' returned error")
+ branch_name = branch_name.strip()
+
+ if branch_name == "HEAD":
+ # If we aren't exactly on a branch, pick a branch which represents
+ # the current commit. If all else fails, we are on a branchless
+ # commit.
+ branches, rc = runner(GITS, ["branch", "--contains"], cwd=root)
+ # --contains was added in git-1.5.4
+ if rc != 0 or branches is None:
+ raise NotThisMethod("'git branch --contains' returned error")
+ branches = branches.split("\n")
+
+ # Remove the first line if we're running detached
+ if "(" in branches[0]:
+ branches.pop(0)
+
+ # Strip off the leading "* " from the list of branches.
+ branches = [branch[2:] for branch in branches]
+ if "master" in branches:
+ branch_name = "master"
+ elif not branches:
+ branch_name = None
+ else:
+ # Pick the first branch that is returned. Good or bad.
+ branch_name = branches[0]
+
+ pieces["branch"] = branch_name
+
# parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
# TAG might have hyphens.
git_describe = describe_out
@@ -270,7 +349,7 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
# TAG-NUM-gHEX
mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
if not mo:
- # unparseable. Maybe git-describe is misbehaving?
+ # unparsable. Maybe git-describe is misbehaving?
pieces["error"] = ("unable to parse git-describe output: '%s'"
% describe_out)
return pieces
@@ -295,13 +374,11 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
else:
# HEX: no tags
pieces["closest-tag"] = None
- count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"],
- cwd=root)
- pieces["distance"] = int(count_out) # total number of commits
+ out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root)
+ pieces["distance"] = len(out.split()) # total number of commits
# commit date: see ISO-8601 comment in git_versions_from_keywords()
- date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"],
- cwd=root)[0].strip()
+ date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip()
# Use only the last line. Previous lines may contain GPG signature
# information.
date = date.splitlines()[-1]
@@ -310,14 +387,14 @@ def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
return pieces
-def plus_or_dot(pieces):
+def plus_or_dot(pieces: Dict[str, Any]) -> str:
"""Return a + if we don't already have one, else return a ."""
if "+" in pieces.get("closest-tag", ""):
return "."
return "+"
-def render_pep440(pieces):
+def render_pep440(pieces: Dict[str, Any]) -> str:
"""Build up version string, with post-release "local version identifier".
Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
@@ -342,23 +419,71 @@ def render_pep440(pieces):
return rendered
-def render_pep440_pre(pieces):
- """TAG[.post0.devDISTANCE] -- No -dirty.
+def render_pep440_branch(pieces: Dict[str, Any]) -> str:
+ """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] .
+
+ The ".dev0" means not master branch. Note that .dev0 sorts backwards
+ (a feature branch will appear "older" than the master branch).
Exceptions:
- 1: no tags. 0.post0.devDISTANCE
+ 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty]
"""
if pieces["closest-tag"]:
rendered = pieces["closest-tag"]
+ if pieces["distance"] or pieces["dirty"]:
+ if pieces["branch"] != "master":
+ rendered += ".dev0"
+ rendered += plus_or_dot(pieces)
+ rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
+ if pieces["dirty"]:
+ rendered += ".dirty"
+ else:
+ # exception #1
+ rendered = "0"
+ if pieces["branch"] != "master":
+ rendered += ".dev0"
+ rendered += "+untagged.%d.g%s" % (pieces["distance"],
+ pieces["short"])
+ if pieces["dirty"]:
+ rendered += ".dirty"
+ return rendered
+
+
+def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]:
+ """Split pep440 version string at the post-release segment.
+
+ Returns the release segments before the post-release and the
+ post-release version number (or -1 if no post-release segment is present).
+ """
+ vc = str.split(ver, ".post")
+ return vc[0], int(vc[1] or 0) if len(vc) == 2 else None
+
+
+def render_pep440_pre(pieces: Dict[str, Any]) -> str:
+ """TAG[.postN.devDISTANCE] -- No -dirty.
+
+ Exceptions:
+ 1: no tags. 0.post0.devDISTANCE
+ """
+ if pieces["closest-tag"]:
if pieces["distance"]:
- rendered += ".post0.dev%d" % pieces["distance"]
+ # update the post release segment
+ tag_version, post_version = pep440_split_post(pieces["closest-tag"])
+ rendered = tag_version
+ if post_version is not None:
+ rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"])
+ else:
+ rendered += ".post0.dev%d" % (pieces["distance"])
+ else:
+ # no commits, use the tag as the version
+ rendered = pieces["closest-tag"]
else:
# exception #1
rendered = "0.post0.dev%d" % pieces["distance"]
return rendered
-def render_pep440_post(pieces):
+def render_pep440_post(pieces: Dict[str, Any]) -> str:
"""TAG[.postDISTANCE[.dev0]+gHEX] .
The ".dev0" means dirty. Note that .dev0 sorts backwards
@@ -385,7 +510,36 @@ def render_pep440_post(pieces):
return rendered
-def render_pep440_old(pieces):
+def render_pep440_post_branch(pieces: Dict[str, Any]) -> str:
+ """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] .
+
+ The ".dev0" means not master branch.
+
+ Exceptions:
+ 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty]
+ """
+ if pieces["closest-tag"]:
+ rendered = pieces["closest-tag"]
+ if pieces["distance"] or pieces["dirty"]:
+ rendered += ".post%d" % pieces["distance"]
+ if pieces["branch"] != "master":
+ rendered += ".dev0"
+ rendered += plus_or_dot(pieces)
+ rendered += "g%s" % pieces["short"]
+ if pieces["dirty"]:
+ rendered += ".dirty"
+ else:
+ # exception #1
+ rendered = "0.post%d" % pieces["distance"]
+ if pieces["branch"] != "master":
+ rendered += ".dev0"
+ rendered += "+g%s" % pieces["short"]
+ if pieces["dirty"]:
+ rendered += ".dirty"
+ return rendered
+
+
+def render_pep440_old(pieces: Dict[str, Any]) -> str:
"""TAG[.postDISTANCE[.dev0]] .
The ".dev0" means dirty.
@@ -407,7 +561,7 @@ def render_pep440_old(pieces):
return rendered
-def render_git_describe(pieces):
+def render_git_describe(pieces: Dict[str, Any]) -> str:
"""TAG[-DISTANCE-gHEX][-dirty].
Like 'git describe --tags --dirty --always'.
@@ -427,7 +581,7 @@ def render_git_describe(pieces):
return rendered
-def render_git_describe_long(pieces):
+def render_git_describe_long(pieces: Dict[str, Any]) -> str:
"""TAG-DISTANCE-gHEX[-dirty].
Like 'git describe --tags --dirty --always -long'.
@@ -447,7 +601,7 @@ def render_git_describe_long(pieces):
return rendered
-def render(pieces, style):
+def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]:
"""Render the given version pieces into the requested style."""
if pieces["error"]:
return {"version": "unknown",
@@ -461,10 +615,14 @@ def render(pieces, style):
if style == "pep440":
rendered = render_pep440(pieces)
+ elif style == "pep440-branch":
+ rendered = render_pep440_branch(pieces)
elif style == "pep440-pre":
rendered = render_pep440_pre(pieces)
elif style == "pep440-post":
rendered = render_pep440_post(pieces)
+ elif style == "pep440-post-branch":
+ rendered = render_pep440_post_branch(pieces)
elif style == "pep440-old":
rendered = render_pep440_old(pieces)
elif style == "git-describe":
@@ -479,7 +637,7 @@ def render(pieces, style):
"date": pieces.get("date")}
-def get_versions():
+def get_versions() -> Dict[str, Any]:
"""Get version information or return default if unable to do so."""
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
# __file__, we can work backwards from there to the root. Some
@@ -500,7 +658,7 @@ def get_versions():
# versionfile_source is the relative path from the top of the source
# tree (where the .git directory might live) to this file. Invert
# this to find the root from __file__.
- for i in cfg.versionfile_source.split('/'):
+ for _ in cfg.versionfile_source.split('/'):
root = os.path.dirname(root)
except NameError:
return {"version": "0+unknown", "full-revisionid": None,
diff --git a/src/pystencils/assignment.py b/src/pystencils/assignment.py
new file mode 100644
index 0000000000000000000000000000000000000000..af32bc664d7e64a4d57bbe6cf782b86af6904a8b
--- /dev/null
+++ b/src/pystencils/assignment.py
@@ -0,0 +1,110 @@
+import numpy as np
+import sympy as sp
+from sympy.codegen.ast import Assignment, AugmentedAssignment
+from sympy.codegen.ast import AddAugmentedAssignment as SpAddAugAssignment
+from sympy.printing.latex import LatexPrinter
+
+__all__ = ['Assignment', 'AugmentedAssignment', 'AddAugmentedAssignment', 'assignment_from_stencil']
+
+
+def print_assignment_latex(printer, expr):
+ binop = f"{expr.binop}=" if isinstance(expr, AugmentedAssignment) else ''
+ """sympy cannot print Assignments as Latex. Thus, this function is added to the sympy Latex printer"""
+ printed_lhs = printer.doprint(expr.lhs)
+ printed_rhs = printer.doprint(expr.rhs)
+ return fr"{printed_lhs} \leftarrow_{{{binop}}} {printed_rhs}"
+
+
+def assignment_str(assignment):
+ op = f"{assignment.binop}=" if isinstance(assignment, AugmentedAssignment) else 'â†'
+ return fr"{assignment.lhs} {op} {assignment.rhs}"
+
+
+_old_new = sp.codegen.ast.Assignment.__new__
+
+
+# TODO Typing Part2 add default type, defult_float_type, default_int_type and use sane defaults
+def _Assignment__new__(cls, lhs, rhs, *args, **kwargs):
+ if isinstance(lhs, (list, tuple, sp.Matrix)) and isinstance(rhs, (list, tuple, sp.Matrix)):
+ assert len(lhs) == len(rhs), f'{lhs} and {rhs} must have same length when performing vector assignment!'
+ return tuple(_old_new(cls, a, b, *args, **kwargs) for a, b in zip(lhs, rhs))
+ return _old_new(cls, lhs, rhs, *args, **kwargs)
+
+
+Assignment.__str__ = assignment_str
+Assignment.__new__ = _Assignment__new__
+LatexPrinter._print_Assignment = print_assignment_latex
+
+AugmentedAssignment.__str__ = assignment_str
+LatexPrinter._print_AugmentedAssignment = print_assignment_latex
+
+sp.MutableDenseMatrix.__hash__ = lambda self: hash(tuple(self))
+
+# Re-Export
+AddAugmentedAssignment = SpAddAugAssignment
+
+
+def assignment_from_stencil(stencil_array, input_field, output_field,
+ normalization_factor=None, order='visual') -> Assignment:
+ """Creates an assignment
+
+ Args:
+ stencil_array: nested list of numpy array defining the stencil weights
+ input_field: field or field access, defining where the stencil should be applied to
+ output_field: field or field access where the result is written to
+ normalization_factor: optional normalization factor for the stencil
+ order: defines how the stencil_array is interpreted. Possible values are 'visual' and 'numpy'.
+ For details see examples
+
+ Returns:
+ Assignment that can be used to create a kernel
+
+ Examples:
+ >>> import pystencils as ps
+ >>> f, g = ps.fields("f, g: [2D]")
+ >>> stencil = [[0, 2, 0],
+ ... [3, 4, 5],
+ ... [0, 6, 0]]
+
+ By default 'visual ordering is used - i.e. the stencil is applied as the nested lists are written down
+ >>> expected_output = Assignment(g[0, 0], 3*f[-1, 0] + 6*f[0, -1] + 4*f[0, 0] + 2*f[0, 1] + 5*f[1, 0])
+ >>> assignment_from_stencil(stencil, f, g, order='visual') == expected_output
+ True
+
+ 'numpy' ordering uses the first coordinate of the stencil array for x offset, second for y offset etc.
+ >>> expected_output = Assignment(g[0, 0], 2*f[-1, 0] + 3*f[0, -1] + 4*f[0, 0] + 5*f[0, 1] + 6*f[1, 0])
+ >>> assignment_from_stencil(stencil, f, g, order='numpy') == expected_output
+ True
+
+ You can also pass field accesses to apply the stencil at an already shifted position:
+ >>> expected_output = Assignment(g[2, 0], 3*f[0, 0] + 6*f[1, -1] + 4*f[1, 0] + 2*f[1, 1] + 5*f[2, 0])
+ >>> assignment_from_stencil(stencil, f[1, 0], g[2, 0]) == expected_output
+ True
+ """
+ from pystencils.field import Field
+
+ stencil_array = np.array(stencil_array)
+ if order == 'visual':
+ stencil_array = np.swapaxes(stencil_array, 0, 1)
+ stencil_array = np.flip(stencil_array, axis=1)
+ elif order == 'numpy':
+ pass
+ else:
+ raise ValueError("'order' has to be either 'visual' or 'numpy'")
+
+ if isinstance(input_field, Field):
+ input_field = input_field.center
+ if isinstance(output_field, Field):
+ output_field = output_field.center
+
+ rhs = 0
+ offset = tuple(s // 2 for s in stencil_array.shape)
+
+ for index, factor in np.ndenumerate(stencil_array):
+ shift = tuple(i - o for i, o in zip(index, offset))
+ rhs += factor * input_field.get_shifted(*shift)
+
+ if normalization_factor:
+ rhs *= normalization_factor
+
+ return Assignment(output_field, rhs)
diff --git a/src/pystencils/backend/kernelcreation/analysis.py b/src/pystencils/backend/kernelcreation/analysis.py
index a72191b5b6f001c21e745c892a991c6058fb0048..05aa7992819be66ed7816882f9eb96372e143d64 100644
--- a/src/pystencils/backend/kernelcreation/analysis.py
+++ b/src/pystencils/backend/kernelcreation/analysis.py
@@ -9,7 +9,8 @@ import sympy as sp
from .context import KernelCreationContext
from ...field import Field
-from ...sympyextensions import Assignment, AssignmentCollection
+from ...assignment import Assignment
+from ...simp import AssignmentCollection
from ..exceptions import PsInternalCompilerError, KernelConstraintsError
diff --git a/src/pystencils/backend/kernelcreation/freeze.py b/src/pystencils/backend/kernelcreation/freeze.py
index 59fa04b3bdb6af98ac584ef7d166167c64423862..f81ed586bc60b6d831ea4b03ff37612841fc7e78 100644
--- a/src/pystencils/backend/kernelcreation/freeze.py
+++ b/src/pystencils/backend/kernelcreation/freeze.py
@@ -7,7 +7,8 @@ import sympy.core.relational
import sympy.logic.boolalg
from sympy.codegen.ast import AssignmentBase, AugmentedAssignment
-from ...sympyextensions.astnodes import Assignment, AssignmentCollection
+from ...assignment import Assignment
+from ...simp import AssignmentCollection
from ...sympyextensions import (
integer_functions,
ConditionalFieldAccess,
diff --git a/src/pystencils/backend/kernelcreation/iteration_space.py b/src/pystencils/backend/kernelcreation/iteration_space.py
index d75de7c3a271cc30ad05677a8ea600f4db2c985b..56e58648966fab4e60b4eea64ab5442b92f91709 100644
--- a/src/pystencils/backend/kernelcreation/iteration_space.py
+++ b/src/pystencils/backend/kernelcreation/iteration_space.py
@@ -6,7 +6,7 @@ from functools import reduce
from operator import mul
from ...defaults import DEFAULTS
-from ...sympyextensions import AssignmentCollection
+from ...simp import AssignmentCollection
from ...field import Field, FieldType
from ..symbols import PsSymbol
diff --git a/src/pystencils/boundaries/boundaryconditions.py b/src/pystencils/boundaries/boundaryconditions.py
index f52573bca41723fc6e71b208227f72cbbc343e5b..cf6a3e82454d2ddbdfe98344479b8871d4d7b53b 100644
--- a/src/pystencils/boundaries/boundaryconditions.py
+++ b/src/pystencils/boundaries/boundaryconditions.py
@@ -1,6 +1,6 @@
from typing import Any, List, Tuple, Sequence
-from pystencils.sympyextensions import Assignment
+from pystencils.assignment import Assignment
from pystencils.boundaries.boundaryhandling import BoundaryOffsetInfo
from pystencils.types import create_type
diff --git a/src/pystencils/boundaries/boundaryhandling.py b/src/pystencils/boundaries/boundaryhandling.py
index 57a1cd95f4cb2e166359e60684a2fe9687e9d320..f171d56091f69fbd1bef2a2edc4cf844a96a9f40 100644
--- a/src/pystencils/boundaries/boundaryhandling.py
+++ b/src/pystencils/boundaries/boundaryhandling.py
@@ -4,7 +4,7 @@ import numpy as np
import sympy as sp
from pystencils import create_kernel, CreateKernelConfig, Target
-from pystencils.sympyextensions import Assignment
+from pystencils.assignment import Assignment
from pystencils.boundaries.createindexlist import (
create_boundary_index_array, numpy_data_type_for_boundary_object)
from pystencils.sympyextensions import TypedSymbol
diff --git a/src/pystencils/fd/derivation.py b/src/pystencils/fd/derivation.py
index f739c8f020404c29101e27d08c016e789baee93f..bea0a9674086f8f353c52f228397a209ed701131 100644
--- a/src/pystencils/fd/derivation.py
+++ b/src/pystencils/fd/derivation.py
@@ -6,7 +6,7 @@ import sympy as sp
from pystencils.field import Field
from pystencils.stencil import direction_string_to_offset
-from pystencils.sympyextensions.math import multidimensional_sum, prod
+from pystencils.sympyextensions import multidimensional_sum, prod
from pystencils.utils import LinearEquationSystem, fully_contains
diff --git a/src/pystencils/fd/derivative.py b/src/pystencils/fd/derivative.py
index 2396fe1a988acdfa39420d75ffd0557c97fd15fd..c119d1e2ec34c32c67f18f7837c43dee05cfc65b 100644
--- a/src/pystencils/fd/derivative.py
+++ b/src/pystencils/fd/derivative.py
@@ -3,7 +3,7 @@ from collections import defaultdict, namedtuple
import sympy as sp
from pystencils.field import Field
-from pystencils.sympyextensions.math import normalize_product, prod
+from pystencils.sympyextensions import normalize_product, prod
def _default_diff_sort_key(d):
diff --git a/src/pystencils/fd/finitedifferences.py b/src/pystencils/fd/finitedifferences.py
index 9c4116ee56eff340b222132a66ecf37740af1b31..0c2425d25095b29ccbfb5387490a4353e677f7e1 100644
--- a/src/pystencils/fd/finitedifferences.py
+++ b/src/pystencils/fd/finitedifferences.py
@@ -7,8 +7,8 @@ from pystencils.fd import Diff
from pystencils.fd.derivative import diff_args
from pystencils.fd.spatial import fd_stencils_standard
from pystencils.field import Field
-from pystencils.sympyextensions import AssignmentCollection
-from pystencils.sympyextensions.math import fast_subs
+from pystencils.simp import AssignmentCollection
+from pystencils.sympyextensions import fast_subs
FieldOrFieldAccess = Union[Field, Field.Access]
diff --git a/src/pystencils/field.py b/src/pystencils/field.py
index ac0aa3ae0c639ad1ace6d7827933ea7a1c9e52d3..2a7b6d3154174d1844597e69785835a3cbce17dd 100644
--- a/src/pystencils/field.py
+++ b/src/pystencils/field.py
@@ -15,8 +15,8 @@ from pystencils.alignedarray import aligned_empty
from pystencils.spatial_coordinates import x_staggered_vector, x_vector
from pystencils.stencil import direction_string_to_offset, inverse_direction, offset_to_direction_string
from pystencils.types import PsType, PsStructType, create_type
-from pystencils.sympyextensions.typed_sympy import (FieldShapeSymbol, FieldStrideSymbol, TypedSymbol)
-from pystencils.sympyextensions.math import is_integer_sequence
+from pystencils.sympyextensions.typed_sympy import FieldShapeSymbol, FieldStrideSymbol, TypedSymbol
+from pystencils.sympyextensions import is_integer_sequence
from pystencils.types import UserTypeSpec
diff --git a/src/pystencils/kernel_decorator.py b/src/pystencils/kernel_decorator.py
index deb94eec0eb5d77f2b67411a45b8c9b23da53e0f..a3590d3a4bdcddb43aba31ddf943206ba7e47f84 100644
--- a/src/pystencils/kernel_decorator.py
+++ b/src/pystencils/kernel_decorator.py
@@ -5,8 +5,8 @@ from typing import Callable, Union, List, Dict, Tuple
import sympy as sp
-from .sympyextensions import Assignment
-from .sympyextensions.math import SymbolCreator
+from .assignment import Assignment
+from .sympyextensions import SymbolCreator
from pystencils.config import CreateKernelConfig
__all__ = ['kernel', 'kernel_config']
diff --git a/src/pystencils/kernelcreation.py b/src/pystencils/kernelcreation.py
index 60500911917e08db1e9dd9aba0f0b20a4e4f3d8d..71ff965487265f47193e471afccd6dedc802eddb 100644
--- a/src/pystencils/kernelcreation.py
+++ b/src/pystencils/kernelcreation.py
@@ -32,7 +32,8 @@ from .backend.transformations import (
SelectFunctions,
)
-from .sympyextensions import AssignmentCollection, Assignment
+from .simp import AssignmentCollection
+from .assignment import Assignment
__all__ = ["create_kernel"]
@@ -155,3 +156,7 @@ def create_kernel_function(
)
kfunc.metadata.update(ctx.metadata)
return kfunc
+
+
+def create_staggered_kernel(assignments, target: Target = Target.CPU, gpu_exclusive_conditions=False, **kwargs):
+ raise NotImplementedError("Staggered kernels are not yet implemented for pystencils 2.0")
diff --git a/src/pystencils/placeholder_function.py b/src/pystencils/placeholder_function.py
index 00acb17bd71cdd7cfb628d89e5e1c85034c449ce..e9a3a0aba7c7b2b81e050029d0b06899a247c1ee 100644
--- a/src/pystencils/placeholder_function.py
+++ b/src/pystencils/placeholder_function.py
@@ -2,7 +2,7 @@ from typing import List
import sympy as sp
-from pystencils.sympyextensions import Assignment
+from .assignment import Assignment
from pystencils.sympyextensions import is_constant
from pystencils.sympyextensions.astnodes import generic_visit
diff --git a/src/pystencils/sympyextensions/rng.py b/src/pystencils/rng.py
similarity index 97%
rename from src/pystencils/sympyextensions/rng.py
rename to src/pystencils/rng.py
index 859669a6ac35e97a13646efcf0274446bc379988..d6c6cd2741ee3e7442bd9fa4a96f4e9983d524e3 100644
--- a/src/pystencils/sympyextensions/rng.py
+++ b/src/pystencils/rng.py
@@ -2,10 +2,9 @@ import copy
import numpy as np
import sympy as sp
-from pystencils.sympyextensions import TypedSymbol, CastFunc
+from .sympyextensions import TypedSymbol, CastFunc, fast_subs
# from pystencils.sympyextensions.astnodes import LoopOverCoordinate # TODO nbackend: replace
# from pystencils.backends.cbackend import CustomCodeNode # TODO nbackend: replace
-from pystencils.sympyextensions import fast_subs
# class RNGBase(CustomCodeNode): TODO nbackend: replace
diff --git a/src/pystencils/simp/__init__.py b/src/pystencils/simp/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..6c553af8bcb16d43e77ddf2515db73a9bde5f1af
--- /dev/null
+++ b/src/pystencils/simp/__init__.py
@@ -0,0 +1,45 @@
+from .assignment_collection import AssignmentCollection
+from .simplifications import (
+ add_subexpressions_for_constants,
+ add_subexpressions_for_divisions,
+ add_subexpressions_for_field_reads,
+ add_subexpressions_for_sums,
+ apply_on_all_subexpressions,
+ apply_to_all_assignments,
+ subexpression_substitution_in_existing_subexpressions,
+ subexpression_substitution_in_main_assignments,
+ sympy_cse,
+ sympy_cse_on_assignment_list,
+)
+from .subexpression_insertion import (
+ insert_aliases,
+ insert_zeros,
+ insert_constants,
+ insert_constant_additions,
+ insert_constant_multiples,
+ insert_squares,
+ insert_symbol_times_minus_one,
+)
+from .simplificationstrategy import SimplificationStrategy
+
+__all__ = [
+ "AssignmentCollection",
+ "SimplificationStrategy",
+ "sympy_cse",
+ "sympy_cse_on_assignment_list",
+ "apply_to_all_assignments",
+ "apply_on_all_subexpressions",
+ "subexpression_substitution_in_existing_subexpressions",
+ "subexpression_substitution_in_main_assignments",
+ "add_subexpressions_for_constants",
+ "add_subexpressions_for_divisions",
+ "add_subexpressions_for_sums",
+ "add_subexpressions_for_field_reads",
+ "insert_aliases",
+ "insert_zeros",
+ "insert_constants",
+ "insert_constant_additions",
+ "insert_constant_multiples",
+ "insert_squares",
+ "insert_symbol_times_minus_one",
+]
diff --git a/src/pystencils/simp/assignment_collection.py b/src/pystencils/simp/assignment_collection.py
new file mode 100644
index 0000000000000000000000000000000000000000..f1ba8715431d96fb2a09a01e45872def421fe94f
--- /dev/null
+++ b/src/pystencils/simp/assignment_collection.py
@@ -0,0 +1,476 @@
+import itertools
+from copy import copy
+from typing import Any, Dict, Iterable, Iterator, List, Optional, Sequence, Set, Union
+
+import sympy as sp
+
+import pystencils
+from ..assignment import Assignment
+from .simplifications import (sort_assignments_topologically, transform_lhs_and_rhs, transform_rhs)
+from ..sympyextensions import count_operations, fast_subs
+
+
+class AssignmentCollection:
+ """
+ A collection of equations with subexpression definitions, also represented as assignments,
+ that are used in the main equations. AssignmentCollection can be passed to simplification methods.
+ These simplification methods can change the subexpressions, but the number and
+ left hand side of the main equations themselves is not altered.
+ Additionally a dictionary of simplification hints is stored, which are set by the functions that create
+ assignment collections to transport information to the simplification system.
+
+ Args:
+ main_assignments: List of assignments. Main assignments are characterised, that the right hand side of each
+ assignment is a field access. Thus the generated equations write on arrays.
+ subexpressions: List of assignments defining subexpressions used in main equations
+ simplification_hints: Dict that is used to annotate the assignment collection with hints that are
+ used by the simplification system. See documentation of the simplification rules for
+ potentially required hints and their meaning.
+ subexpression_symbol_generator: Generator for new symbols that are used when new subexpressions are added
+ used to get new symbols that are unique for this AssignmentCollection
+
+ """
+
+ __match_args__ = ("main_assignments", "subexpressions")
+
+ # ------------------------------- Creation & Inplace Manipulation --------------------------------------------------
+
+ def __init__(self, main_assignments: Union[List[Assignment], Dict[sp.Expr, sp.Expr]],
+ subexpressions: Union[List[Assignment], Dict[sp.Expr, sp.Expr]] = None,
+ simplification_hints: Optional[Dict[str, Any]] = None,
+ subexpression_symbol_generator: Iterator[sp.Symbol] = None) -> None:
+
+ if subexpressions is None:
+ subexpressions = {}
+
+ if isinstance(main_assignments, Dict):
+ main_assignments = [Assignment(k, v)
+ for k, v in main_assignments.items()]
+ if isinstance(subexpressions, Dict):
+ subexpressions = [Assignment(k, v)
+ for k, v in subexpressions.items()]
+
+ main_assignments = list(itertools.chain.from_iterable(
+ [(a if isinstance(a, Iterable) else [a]) for a in main_assignments]))
+ subexpressions = list(itertools.chain.from_iterable(
+ [(a if isinstance(a, Iterable) else [a]) for a in subexpressions]))
+
+ self.main_assignments = main_assignments
+ self.subexpressions = subexpressions
+
+ if simplification_hints is None:
+ simplification_hints = {}
+
+ self.simplification_hints = simplification_hints
+
+ ctrs = [int(n.name[3:])for n in self.rhs_symbols if "xi_" in n.name]
+ max_ctr = max(ctrs) + 1 if len(ctrs) > 0 else 0
+
+ if subexpression_symbol_generator is None:
+ self.subexpression_symbol_generator = SymbolGen(ctr=max_ctr)
+ else:
+ self.subexpression_symbol_generator = subexpression_symbol_generator
+
+ def add_simplification_hint(self, key: str, value: Any) -> None:
+ """Adds an entry to the simplification_hints dictionary and checks that is does not exist yet."""
+ assert key not in self.simplification_hints, "This hint already exists"
+ self.simplification_hints[key] = value
+
+ def add_subexpression(self, rhs: sp.Expr, lhs: Optional[sp.Symbol] = None, topological_sort=True) -> sp.Symbol:
+ """Adds a subexpression to current collection.
+
+ Args:
+ rhs: right hand side of new subexpression
+ lhs: optional left hand side of new subexpression. If None a new unique symbol is generated.
+ topological_sort: sort the subexpressions topologically after insertion, to make sure that
+ definition of a symbol comes before its usage. If False, subexpression is appended.
+
+ Returns:
+ left hand side symbol (which could have been generated)
+ """
+ if lhs is None:
+ lhs = next(self.subexpression_symbol_generator)
+ eq = Assignment(lhs, rhs)
+ self.subexpressions.append(eq)
+ if topological_sort:
+ self.topological_sort(sort_subexpressions=True,
+ sort_main_assignments=False)
+ return lhs
+
+ def topological_sort(self, sort_subexpressions: bool = True, sort_main_assignments: bool = True) -> None:
+ """Sorts subexpressions and/or main_equations topologically to make sure symbol usage comes after definition."""
+ if sort_subexpressions:
+ self.subexpressions = sort_assignments_topologically(self.subexpressions)
+ if sort_main_assignments:
+ self.main_assignments = sort_assignments_topologically(self.main_assignments)
+
+ # ---------------------------------------------- Properties -------------------------------------------------------
+
+ @property
+ def all_assignments(self) -> List[Assignment]:
+ """Subexpression and main equations as a single list."""
+ return self.subexpressions + self.main_assignments
+
+ @property
+ def rhs_symbols(self) -> Set[sp.Symbol]:
+ """All symbols used in the assignment collection, which occur on the rhs of any assignment."""
+ rhs_symbols = set()
+ for eq in self.all_assignments:
+ if isinstance(eq, Assignment):
+ rhs_symbols.update(eq.rhs.atoms(sp.Symbol))
+ # elif isinstance(eq, pystencils.astnodes.Node): # TODO remove or replace
+ # rhs_symbols.update(eq.undefined_symbols)
+
+ return rhs_symbols
+
+ @property
+ def free_symbols(self) -> Set[sp.Symbol]:
+ """All symbols used in the assignment collection, which do not occur as left hand sides in any assignment."""
+ return self.rhs_symbols - self.bound_symbols
+
+ @property
+ def bound_symbols(self) -> Set[sp.Symbol]:
+ """All symbols which occur on the left hand side of a main assignment or a subexpression."""
+ bound_symbols_set = set(
+ [assignment.lhs for assignment in self.all_assignments if isinstance(assignment, Assignment)]
+ )
+
+ assert len(bound_symbols_set) == len(list(a for a in self.all_assignments if isinstance(a, Assignment))), \
+ "Not in SSA form - same symbol assigned multiple times"
+
+ # bound_symbols_set = bound_symbols_set.union(*[
+ # assignment.symbols_defined for assignment in self.all_assignments
+ # if isinstance(assignment, pystencils.astnodes.Node)
+ # ]) TODO: replace?
+
+ return bound_symbols_set
+
+ @property
+ def rhs_fields(self):
+ """All fields accessed in the assignment collection, which do not occur as left hand sides in any assignment."""
+ return {s.field for s in self.rhs_symbols if hasattr(s, 'field')}
+
+ @property
+ def free_fields(self):
+ """All fields accessed in the assignment collection, which do not occur as left hand sides in any assignment."""
+ return {s.field for s in self.free_symbols if hasattr(s, 'field')}
+
+ @property
+ def bound_fields(self):
+ """All field accessed on the left hand side of a main assignment or a subexpression."""
+ return {s.field for s in self.bound_symbols if hasattr(s, 'field')}
+
+ @property
+ def defined_symbols(self) -> Set[sp.Symbol]:
+ """All symbols which occur as left-hand-sides of one of the main equations"""
+ lhs_set = set([assignment.lhs for assignment in self.main_assignments if isinstance(assignment, Assignment)])
+ return lhs_set
+ # return (lhs_set.union(*[assignment.symbols_defined for assignment in self.main_assignments
+ # if isinstance(assignment, pystencils.astnodes.Node)])) TODO
+
+ @property
+ def operation_count(self):
+ """See :func:`count_operations` """
+ return count_operations(self.all_assignments, only_type=None)
+
+ def atoms(self, *args):
+ return set().union(*[a.atoms(*args) for a in self.all_assignments])
+
+ def dependent_symbols(self, symbols: Iterable[sp.Symbol]) -> Set[sp.Symbol]:
+ """Returns all symbols that depend on one of the passed symbols.
+
+ A symbol 'a' depends on a symbol 'b', if there is an assignment 'a <- some_expression(b)' i.e. when
+ 'b' is required to compute 'a'.
+ """
+
+ queue = list(symbols)
+
+ def add_symbols_from_expr(expr):
+ dependent_symbols = expr.atoms(sp.Symbol)
+ for ds in dependent_symbols:
+ queue.append(ds)
+
+ handled_symbols = set()
+ assignment_dict = {e.lhs: e.rhs for e in self.all_assignments}
+
+ while len(queue) > 0:
+ e = queue.pop(0)
+ if e in handled_symbols:
+ continue
+ if e in assignment_dict:
+ add_symbols_from_expr(assignment_dict[e])
+ handled_symbols.add(e)
+
+ return handled_symbols
+
+ def lambdify(self, symbols: Sequence[sp.Symbol], fixed_symbols: Optional[Dict[sp.Symbol, Any]] = None, module=None):
+ """Returns a python function to evaluate this equation collection.
+
+ Args:
+ symbols: symbol(s) which are the parameter for the created function
+ fixed_symbols: dictionary with substitutions, that are applied before sympy's lambdify
+ module: same as sympy.lambdify parameter. Defines which module to use e.g. 'numpy'
+
+ Examples:
+ >>> a, b, c, d = sp.symbols("a b c d")
+ >>> ac = AssignmentCollection([Assignment(c, a + b), Assignment(d, a**2 + b)],
+ ... subexpressions=[Assignment(b, a + b / 2)])
+ >>> python_function = ac.lambdify([a], fixed_symbols={b: 2})
+ >>> python_function(4)
+ {c: 6, d: 18}
+ """
+ assignments = self.new_with_substitutions(fixed_symbols, substitute_on_lhs=False) if fixed_symbols else self
+ assignments = assignments.new_without_subexpressions().main_assignments
+ lambdas = {assignment.lhs: sp.lambdify(symbols, assignment.rhs, module) for assignment in assignments}
+
+ def f(*args, **kwargs):
+ return {s: func(*args, **kwargs) for s, func in lambdas.items()}
+
+ return f
+
+ # ---------------------------- Creating new modified collections ---------------------------------------------------
+
+ def copy(self,
+ main_assignments: Optional[List[Assignment]] = None,
+ subexpressions: Optional[List[Assignment]] = None) -> 'AssignmentCollection':
+ """Returns a copy with optionally replaced main_assignments and/or subexpressions."""
+
+ res = copy(self)
+ res.simplification_hints = self.simplification_hints.copy()
+ res.subexpression_symbol_generator = copy(self.subexpression_symbol_generator)
+
+ if main_assignments is not None:
+ res.main_assignments = main_assignments
+ else:
+ res.main_assignments = self.main_assignments.copy()
+
+ if subexpressions is not None:
+ res.subexpressions = subexpressions
+ else:
+ res.subexpressions = self.subexpressions.copy()
+
+ return res
+
+ def new_with_substitutions(self, substitutions: Dict, add_substitutions_as_subexpressions: bool = False,
+ substitute_on_lhs: bool = True,
+ sort_topologically: bool = True) -> 'AssignmentCollection':
+ """Returns new object, where terms are substituted according to the passed substitution dict.
+
+ Args:
+ substitutions: dict that is passed to sympy subs, substitutions are done main assignments and subexpressions
+ add_substitutions_as_subexpressions: if True, the substitutions are added as assignments to subexpressions
+ substitute_on_lhs: if False, the substitutions are done only on the right hand side of assignments
+ sort_topologically: if subexpressions are added as substitutions and this parameters is true,
+ the subexpressions are sorted topologically after insertion
+ Returns:
+ New AssignmentCollection where substitutions have been applied, self is not altered.
+ """
+ transform = transform_lhs_and_rhs if substitute_on_lhs else transform_rhs
+ transformed_subexpressions = transform(self.subexpressions, fast_subs, substitutions)
+ transformed_assignments = transform(self.main_assignments, fast_subs, substitutions)
+
+ if add_substitutions_as_subexpressions:
+ transformed_subexpressions = [Assignment(b, a) for a, b in
+ substitutions.items()] + transformed_subexpressions
+ if sort_topologically:
+ transformed_subexpressions = sort_assignments_topologically(transformed_subexpressions)
+ return self.copy(transformed_assignments, transformed_subexpressions)
+
+ def new_merged(self, other: 'AssignmentCollection') -> 'AssignmentCollection':
+ """Returns a new collection which contains self and other. Subexpressions are renamed if they clash."""
+ own_definitions = set([e.lhs for e in self.main_assignments])
+ other_definitions = set([e.lhs for e in other.main_assignments])
+ assert len(own_definitions.intersection(other_definitions)) == 0, \
+ "Cannot merge collections, since both define the same symbols"
+
+ own_subexpression_symbols = {e.lhs: e.rhs for e in self.subexpressions}
+ substitution_dict = {}
+
+ processed_other_subexpression_equations = []
+ for other_subexpression_eq in other.subexpressions:
+ if other_subexpression_eq.lhs in own_subexpression_symbols:
+ new_rhs = fast_subs(other_subexpression_eq.rhs, substitution_dict)
+ if new_rhs == own_subexpression_symbols[other_subexpression_eq.lhs]:
+ continue # exact the same subexpression equation exists already
+ else:
+ # different definition - a new name has to be introduced
+ new_lhs = next(self.subexpression_symbol_generator)
+ new_eq = Assignment(new_lhs, new_rhs)
+ processed_other_subexpression_equations.append(new_eq)
+ substitution_dict[other_subexpression_eq.lhs] = new_lhs
+ else:
+ processed_other_subexpression_equations.append(fast_subs(other_subexpression_eq, substitution_dict))
+
+ processed_other_main_assignments = [fast_subs(eq, substitution_dict) for eq in other.main_assignments]
+ return self.copy(self.main_assignments + processed_other_main_assignments,
+ self.subexpressions + processed_other_subexpression_equations)
+
+ def new_filtered(self, symbols_to_extract: Iterable[sp.Symbol]) -> 'AssignmentCollection':
+ """Extracts equations that have symbols_to_extract as left hand side, together with necessary subexpressions.
+
+ Returns:
+ new AssignmentCollection, self is not altered
+ """
+ symbols_to_extract = set(symbols_to_extract)
+ dependent_symbols = self.dependent_symbols(symbols_to_extract)
+ new_assignments = []
+ for eq in self.all_assignments:
+ if eq.lhs in symbols_to_extract:
+ new_assignments.append(eq)
+
+ new_sub_expr = [eq for eq in self.all_assignments
+ if eq.lhs in dependent_symbols and eq.lhs not in symbols_to_extract]
+ return self.copy(new_assignments, new_sub_expr)
+
+ def new_without_unused_subexpressions(self) -> 'AssignmentCollection':
+ """Returns new collection that only contains subexpressions required to compute the main assignments."""
+ all_lhs = [eq.lhs for eq in self.main_assignments]
+ return self.new_filtered(all_lhs)
+
+ def new_with_inserted_subexpression(self, symbol: sp.Symbol) -> 'AssignmentCollection':
+ """Eliminates the subexpression with the given symbol on its left hand side, by substituting it everywhere."""
+ new_subexpressions = []
+ subs_dict = None
+ for se in self.subexpressions:
+ if se.lhs == symbol:
+ subs_dict = {se.lhs: se.rhs}
+ else:
+ new_subexpressions.append(se)
+ if subs_dict is None:
+ return self
+
+ new_subexpressions = [Assignment(eq.lhs, fast_subs(eq.rhs, subs_dict)) for eq in new_subexpressions]
+ new_eqs = [Assignment(eq.lhs, fast_subs(eq.rhs, subs_dict)) for eq in self.main_assignments]
+ return self.copy(new_eqs, new_subexpressions)
+
+ def new_without_subexpressions(self, subexpressions_to_keep=None) -> 'AssignmentCollection':
+ """Returns a new collection where all subexpressions have been inserted."""
+ if subexpressions_to_keep is None:
+ subexpressions_to_keep = set()
+ if len(self.subexpressions) == 0:
+ return self.copy()
+
+ subexpressions_to_keep = set(subexpressions_to_keep)
+
+ kept_subexpressions = []
+ if self.subexpressions[0].lhs in subexpressions_to_keep:
+ substitution_dict = {}
+ kept_subexpressions.append(self.subexpressions[0])
+ else:
+ substitution_dict = {self.subexpressions[0].lhs: self.subexpressions[0].rhs}
+
+ subexpression = [e for e in self.subexpressions]
+ for i in range(1, len(subexpression)):
+ subexpression[i] = fast_subs(subexpression[i], substitution_dict)
+ if subexpression[i].lhs in subexpressions_to_keep:
+ kept_subexpressions.append(subexpression[i])
+ else:
+ substitution_dict[subexpression[i].lhs] = subexpression[i].rhs
+
+ new_assignment = [fast_subs(eq, substitution_dict) for eq in self.main_assignments]
+ return self.copy(new_assignment, kept_subexpressions)
+
+ # ----------------------------------------- Display and Printing -------------------------------------------------
+
+ def _repr_html_(self):
+ """Interface to Jupyter notebook, to display as a nicely formatted HTML table"""
+
+ def make_html_equation_table(equations):
+ no_border = 'style="border:none"'
+ html_table = '<table style="border:none; width: 100%; ">'
+ line = '<tr {nb}> <td {nb}>$${eq}$$</td> </tr> '
+ for eq in equations:
+ format_dict = {'eq': sp.latex(eq),
+ 'nb': no_border, }
+ html_table += line.format(**format_dict)
+ html_table += "</table>"
+ return html_table
+
+ result = ""
+ if len(self.subexpressions) > 0:
+ result += "<div>Subexpressions:</div>"
+ result += make_html_equation_table(self.subexpressions)
+ result += "<div>Main Assignments:</div>"
+ result += make_html_equation_table(self.main_assignments)
+ return result
+
+ def __repr__(self):
+ return f"AssignmentCollection: {str(tuple(self.defined_symbols))[1:-1]} <- f{tuple(self.free_symbols)}"
+
+ def __str__(self):
+ result = "Subexpressions:\n"
+ for eq in self.subexpressions:
+ result += f"\t{eq}\n"
+ result += "Main Assignments:\n"
+ for eq in self.main_assignments:
+ result += f"\t{eq}\n"
+ return result
+
+ def __iter__(self):
+ return self.all_assignments.__iter__()
+
+ @property
+ def main_assignments_dict(self):
+ return {a.lhs: a.rhs for a in self.main_assignments}
+
+ @property
+ def subexpressions_dict(self):
+ return {a.lhs: a.rhs for a in self.subexpressions}
+
+ def set_main_assignments_from_dict(self, main_assignments_dict):
+ self.main_assignments = [Assignment(k, v)
+ for k, v in main_assignments_dict.items()]
+
+ def set_sub_expressions_from_dict(self, sub_expressions_dict):
+ self.subexpressions = [Assignment(k, v)
+ for k, v in sub_expressions_dict.items()]
+
+ def find(self, *args, **kwargs):
+ return set.union(
+ *[a.find(*args, **kwargs) for a in self.all_assignments]
+ )
+
+ def match(self, *args, **kwargs):
+ rtn = {}
+ for a in self.all_assignments:
+ partial_result = a.match(*args, **kwargs)
+ if partial_result:
+ rtn.update(partial_result)
+ return rtn
+
+ def subs(self, *args, **kwargs):
+ return AssignmentCollection(
+ main_assignments=[a.subs(*args, **kwargs) for a in self.main_assignments],
+ subexpressions=[a.subs(*args, **kwargs) for a in self.subexpressions]
+ )
+
+ def replace(self, *args, **kwargs):
+ return AssignmentCollection(
+ main_assignments=[a.replace(*args, **kwargs) for a in self.main_assignments],
+ subexpressions=[a.replace(*args, **kwargs) for a in self.subexpressions]
+ )
+
+ def __eq__(self, other):
+ return set(self.all_assignments) == set(other.all_assignments)
+
+ def __bool__(self):
+ return bool(self.all_assignments)
+
+
+class SymbolGen:
+ """Default symbol generator producing number symbols ζ_0, ζ_1, ..."""
+
+ def __init__(self, symbol="xi", dtype=None, ctr=0):
+ self._ctr = ctr
+ self._symbol = symbol
+ self._dtype = dtype
+
+ def __iter__(self):
+ return self
+
+ def __next__(self):
+ name = f"{self._symbol}_{self._ctr}"
+ self._ctr += 1
+ if self._dtype is not None:
+ return pystencils.TypedSymbol(name, self._dtype)
+ return sp.Symbol(name)
diff --git a/src/pystencils/sympyextensions/simplifications.py b/src/pystencils/simp/simplifications.py
similarity index 97%
rename from src/pystencils/sympyextensions/simplifications.py
rename to src/pystencils/simp/simplifications.py
index cdcad81e772d7c837cfd761a287b777f94397078..9368c8f51a4aabd03c15a0741db5930eb8865884 100644
--- a/src/pystencils/sympyextensions/simplifications.py
+++ b/src/pystencils/simp/simplifications.py
@@ -4,9 +4,9 @@ from collections import defaultdict
import sympy as sp
-from .astnodes import Assignment
-from .math import subs_additive, is_constant, recursive_collect
-from .typed_sympy import TypedSymbol
+from ..assignment import Assignment
+from ..sympyextensions import subs_additive, is_constant, recursive_collect
+from ..sympyextensions.typed_sympy import TypedSymbol
# TODO rewrite with SymPy AST
@@ -55,7 +55,7 @@ def sympy_cse(ac, **kwargs):
def sympy_cse_on_assignment_list(assignments: List[Assignment]) -> List[Assignment]:
"""Extracts common subexpressions from a list of assignments."""
- from pystencils.sympyextensions import AssignmentCollection
+ from pystencils.simp import AssignmentCollection
ec = AssignmentCollection([], assignments)
return sympy_cse(ec).all_assignments
diff --git a/src/pystencils/sympyextensions/simplificationstrategy.py b/src/pystencils/simp/simplificationstrategy.py
similarity index 99%
rename from src/pystencils/sympyextensions/simplificationstrategy.py
rename to src/pystencils/simp/simplificationstrategy.py
index b76d12711db5234aa9d29a7fd5608e2bab010178..22ffa34d04bc2731f615bd685137c8abebf9d58b 100644
--- a/src/pystencils/sympyextensions/simplificationstrategy.py
+++ b/src/pystencils/simp/simplificationstrategy.py
@@ -3,7 +3,7 @@ from typing import Any, Callable, Optional, Sequence
import sympy as sp
-from .astnodes import AssignmentCollection
+from ..simp import AssignmentCollection
class SimplificationStrategy:
diff --git a/src/pystencils/sympyextensions/subexpression_insertion.py b/src/pystencils/simp/subexpression_insertion.py
similarity index 98%
rename from src/pystencils/sympyextensions/subexpression_insertion.py
rename to src/pystencils/simp/subexpression_insertion.py
index 8cedad4665033e91a6812d4c9c23634c8d208c70..33dfbc351b1f766d63ce867c860bbabaf56fa187 100644
--- a/src/pystencils/sympyextensions/subexpression_insertion.py
+++ b/src/pystencils/simp/subexpression_insertion.py
@@ -1,5 +1,5 @@
import sympy as sp
-from .math import is_constant
+from ..sympyextensions import is_constant
# Subexpression Insertion
diff --git a/src/pystencils/sympyextensions/__init__.py b/src/pystencils/sympyextensions/__init__.py
index fd1145bcbc0422247873c9c3c4864a50f80db48d..847a4380b2ccdbac11c3142d19f3db476ee7880b 100644
--- a/src/pystencils/sympyextensions/__init__.py
+++ b/src/pystencils/sympyextensions/__init__.py
@@ -1,34 +1,5 @@
-from .astnodes import (
- Assignment,
- AugmentedAssignment,
- AddAugmentedAssignment,
- AssignmentCollection,
- SymbolGen,
- ConditionalFieldAccess
-)
+from .astnodes import ConditionalFieldAccess
from .typed_sympy import TypedSymbol, CastFunc
-from .simplificationstrategy import SimplificationStrategy
-from .simplifications import (
- sympy_cse,
- sympy_cse_on_assignment_list,
- apply_to_all_assignments,
- apply_on_all_subexpressions,
- subexpression_substitution_in_existing_subexpressions,
- subexpression_substitution_in_main_assignments,
- add_subexpressions_for_constants,
- add_subexpressions_for_divisions,
- add_subexpressions_for_sums,
- add_subexpressions_for_field_reads
-)
-from .subexpression_insertion import (
- insert_aliases,
- insert_zeros,
- insert_constants,
- insert_constant_additions,
- insert_constant_multiples,
- insert_squares,
- insert_symbol_times_minus_one,
-)
from .math import (
prod,
@@ -55,36 +26,14 @@ from .math import (
count_operations_in_ast,
common_denominator,
get_symmetric_part,
+ SymbolCreator
)
__all__ = [
- "Assignment",
- "AugmentedAssignment",
- "AddAugmentedAssignment",
- "AssignmentCollection",
- "SymbolGen",
"ConditionalFieldAccess",
"TypedSymbol",
"CastFunc",
- "SimplificationStrategy",
- "sympy_cse",
- "sympy_cse_on_assignment_list",
- "apply_to_all_assignments",
- "apply_on_all_subexpressions",
- "subexpression_substitution_in_existing_subexpressions",
- "subexpression_substitution_in_main_assignments",
- "add_subexpressions_for_constants",
- "add_subexpressions_for_divisions",
- "add_subexpressions_for_sums",
- "add_subexpressions_for_field_reads",
- "insert_aliases",
- "insert_zeros",
- "insert_constants",
- "insert_constant_additions",
- "insert_constant_multiples",
- "insert_squares",
- "insert_symbol_times_minus_one",
"remove_higher_order_terms",
"prod",
"remove_small_floats",
@@ -110,4 +59,5 @@ __all__ = [
"count_operations_in_ast",
"common_denominator",
"get_symmetric_part",
+ "SymbolCreator"
]
diff --git a/src/pystencils/sympyextensions/astnodes.py b/src/pystencils/sympyextensions/astnodes.py
index 68613b41a315959e97c3e86908a48ffd5892c9f2..74906cc5ccf9150feac1fd291e3363c90408d295 100644
--- a/src/pystencils/sympyextensions/astnodes.py
+++ b/src/pystencils/sympyextensions/astnodes.py
@@ -1,592 +1,4 @@
-from copy import copy
-import itertools
-import uuid
-from typing import Any, Dict, Iterable, Iterator, List, Optional, Sequence, Set, Union
-
import sympy as sp
-from sympy.codegen.ast import Assignment, AugmentedAssignment
-from sympy.codegen.ast import AddAugmentedAssignment as SpAddAugAssignment
-from sympy.printing.latex import LatexPrinter
-import numpy as np
-
-from .math import count_operations, fast_subs
-from .simplifications import (sort_assignments_topologically, transform_lhs_and_rhs, transform_rhs)
-from .typed_sympy import create_type, TypedSymbol
-
-
-def print_assignment_latex(printer, expr):
- binop = f"{expr.binop}=" if isinstance(expr, AugmentedAssignment) else ''
- """sympy cannot print Assignments as Latex. Thus, this function is added to the sympy Latex printer"""
- printed_lhs = printer.doprint(expr.lhs)
- printed_rhs = printer.doprint(expr.rhs)
- return fr"{printed_lhs} \leftarrow_{{{binop}}} {printed_rhs}"
-
-
-def assignment_str(assignment):
- op = f"{assignment.binop}=" if isinstance(assignment, AugmentedAssignment) else 'â†'
- return fr"{assignment.lhs} {op} {assignment.rhs}"
-
-
-_old_new = sp.codegen.ast.Assignment.__new__
-
-
-# TODO Typing Part2 add default type, defult_float_type, default_int_type and use sane defaults
-def _Assignment__new__(cls, lhs, rhs, *args, **kwargs):
- if isinstance(lhs, (list, tuple, sp.Matrix)) and isinstance(rhs, (list, tuple, sp.Matrix)):
- assert len(lhs) == len(rhs), f'{lhs} and {rhs} must have same length when performing vector assignment!'
- return tuple(_old_new(cls, a, b, *args, **kwargs) for a, b in zip(lhs, rhs))
- return _old_new(cls, lhs, rhs, *args, **kwargs)
-
-
-Assignment.__str__ = assignment_str
-Assignment.__new__ = _Assignment__new__
-LatexPrinter._print_Assignment = print_assignment_latex
-
-AugmentedAssignment.__str__ = assignment_str
-LatexPrinter._print_AugmentedAssignment = print_assignment_latex
-
-sp.MutableDenseMatrix.__hash__ = lambda self: hash(tuple(self))
-
-# Re-Export
-AddAugmentedAssignment = SpAddAugAssignment
-
-
-def assignment_from_stencil(stencil_array, input_field, output_field,
- normalization_factor=None, order='visual') -> Assignment:
- """Creates an assignment
-
- Args:
- stencil_array: nested list of numpy array defining the stencil weights
- input_field: field or field access, defining where the stencil should be applied to
- output_field: field or field access where the result is written to
- normalization_factor: optional normalization factor for the stencil
- order: defines how the stencil_array is interpreted. Possible values are 'visual' and 'numpy'.
- For details see examples
-
- Returns:
- Assignment that can be used to create a kernel
-
- Examples:
- >>> import pystencils as ps
- >>> f, g = ps.fields("f, g: [2D]")
- >>> stencil = [[0, 2, 0],
- ... [3, 4, 5],
- ... [0, 6, 0]]
-
- By default 'visual ordering is used - i.e. the stencil is applied as the nested lists are written down
- >>> expected_output = Assignment(g[0, 0], 3*f[-1, 0] + 6*f[0, -1] + 4*f[0, 0] + 2*f[0, 1] + 5*f[1, 0])
- >>> assignment_from_stencil(stencil, f, g, order='visual') == expected_output
- True
-
- 'numpy' ordering uses the first coordinate of the stencil array for x offset, second for y offset etc.
- >>> expected_output = Assignment(g[0, 0], 2*f[-1, 0] + 3*f[0, -1] + 4*f[0, 0] + 5*f[0, 1] + 6*f[1, 0])
- >>> assignment_from_stencil(stencil, f, g, order='numpy') == expected_output
- True
-
- You can also pass field accesses to apply the stencil at an already shifted position:
- >>> expected_output = Assignment(g[2, 0], 3*f[0, 0] + 6*f[1, -1] + 4*f[1, 0] + 2*f[1, 1] + 5*f[2, 0])
- >>> assignment_from_stencil(stencil, f[1, 0], g[2, 0]) == expected_output
- True
- """
- from pystencils.field import Field
-
- stencil_array = np.array(stencil_array)
- if order == 'visual':
- stencil_array = np.swapaxes(stencil_array, 0, 1)
- stencil_array = np.flip(stencil_array, axis=1)
- elif order == 'numpy':
- pass
- else:
- raise ValueError("'order' has to be either 'visual' or 'numpy'")
-
- if isinstance(input_field, Field):
- input_field = input_field.center
- if isinstance(output_field, Field):
- output_field = output_field.center
-
- rhs = 0
- offset = tuple(s // 2 for s in stencil_array.shape)
-
- for index, factor in np.ndenumerate(stencil_array):
- shift = tuple(i - o for i, o in zip(index, offset))
- rhs += factor * input_field.get_shifted(*shift)
-
- if normalization_factor:
- rhs *= normalization_factor
-
- return Assignment(output_field, rhs)
-
-
-class AssignmentCollection:
- """
- A collection of equations with subexpression definitions, also represented as assignments,
- that are used in the main equations. AssignmentCollection can be passed to simplification methods.
- These simplification methods can change the subexpressions, but the number and
- left hand side of the main equations themselves is not altered.
- Additionally a dictionary of simplification hints is stored, which are set by the functions that create
- assignment collections to transport information to the simplification system.
-
- Args:
- main_assignments: List of assignments. Main assignments are characterised, that the right hand side of each
- assignment is a field access. Thus the generated equations write on arrays.
- subexpressions: List of assignments defining subexpressions used in main equations
- simplification_hints: Dict that is used to annotate the assignment collection with hints that are
- used by the simplification system. See documentation of the simplification rules for
- potentially required hints and their meaning.
- subexpression_symbol_generator: Generator for new symbols that are used when new subexpressions are added
- used to get new symbols that are unique for this AssignmentCollection
-
- """
-
- __match_args__ = ("main_assignments", "subexpressions")
-
- # ------------------------------- Creation & Inplace Manipulation --------------------------------------------------
-
- def __init__(self, main_assignments: Union[List[Assignment], Dict[sp.Expr, sp.Expr]],
- subexpressions: Union[List[Assignment], Dict[sp.Expr, sp.Expr]] = None,
- simplification_hints: Optional[Dict[str, Any]] = None,
- subexpression_symbol_generator: Iterator[sp.Symbol] = None) -> None:
-
- if subexpressions is None:
- subexpressions = {}
-
- if isinstance(main_assignments, Dict):
- main_assignments = [Assignment(k, v)
- for k, v in main_assignments.items()]
- if isinstance(subexpressions, Dict):
- subexpressions = [Assignment(k, v)
- for k, v in subexpressions.items()]
-
- main_assignments = list(itertools.chain.from_iterable(
- [(a if isinstance(a, Iterable) else [a]) for a in main_assignments]))
- subexpressions = list(itertools.chain.from_iterable(
- [(a if isinstance(a, Iterable) else [a]) for a in subexpressions]))
-
- self.main_assignments = main_assignments
- self.subexpressions = subexpressions
-
- if simplification_hints is None:
- simplification_hints = {}
-
- self.simplification_hints = simplification_hints
-
- ctrs = [int(n.name[3:])for n in self.rhs_symbols if "xi_" in n.name]
- max_ctr = max(ctrs) + 1 if len(ctrs) > 0 else 0
-
- if subexpression_symbol_generator is None:
- self.subexpression_symbol_generator = SymbolGen(ctr=max_ctr)
- else:
- self.subexpression_symbol_generator = subexpression_symbol_generator
-
- def add_simplification_hint(self, key: str, value: Any) -> None:
- """Adds an entry to the simplification_hints dictionary and checks that is does not exist yet."""
- assert key not in self.simplification_hints, "This hint already exists"
- self.simplification_hints[key] = value
-
- def add_subexpression(self, rhs: sp.Expr, lhs: Optional[sp.Symbol] = None, topological_sort=True) -> sp.Symbol:
- """Adds a subexpression to current collection.
-
- Args:
- rhs: right hand side of new subexpression
- lhs: optional left hand side of new subexpression. If None a new unique symbol is generated.
- topological_sort: sort the subexpressions topologically after insertion, to make sure that
- definition of a symbol comes before its usage. If False, subexpression is appended.
-
- Returns:
- left hand side symbol (which could have been generated)
- """
- if lhs is None:
- lhs = next(self.subexpression_symbol_generator)
- eq = Assignment(lhs, rhs)
- self.subexpressions.append(eq)
- if topological_sort:
- self.topological_sort(sort_subexpressions=True,
- sort_main_assignments=False)
- return lhs
-
- def topological_sort(self, sort_subexpressions: bool = True, sort_main_assignments: bool = True) -> None:
- """Sorts subexpressions and/or main_equations topologically to make sure symbol usage comes after definition."""
- if sort_subexpressions:
- self.subexpressions = sort_assignments_topologically(self.subexpressions)
- if sort_main_assignments:
- self.main_assignments = sort_assignments_topologically(self.main_assignments)
-
- # ---------------------------------------------- Properties -------------------------------------------------------
-
- @property
- def all_assignments(self) -> List[Assignment]:
- """Subexpression and main equations as a single list."""
- return self.subexpressions + self.main_assignments
-
- @property
- def rhs_symbols(self) -> Set[sp.Symbol]:
- """All symbols used in the assignment collection, which occur on the rhs of any assignment."""
- rhs_symbols = set()
- for eq in self.all_assignments:
- if isinstance(eq, Assignment):
- rhs_symbols.update(eq.rhs.atoms(sp.Symbol))
- # TODO rewrite with SymPy AST
- # elif isinstance(eq, pystencils.astnodes.Node):
- # rhs_symbols.update(eq.undefined_symbols)
-
- return rhs_symbols
-
- @property
- def free_symbols(self) -> Set[sp.Symbol]:
- """All symbols used in the assignment collection, which do not occur as left hand sides in any assignment."""
- return self.rhs_symbols - self.bound_symbols
-
- @property
- def bound_symbols(self) -> Set[sp.Symbol]:
- """All symbols which occur on the left hand side of a main assignment or a subexpression."""
- bound_symbols_set = set(
- [assignment.lhs for assignment in self.all_assignments if isinstance(assignment, Assignment)]
- )
-
- assert len(bound_symbols_set) == len(list(a for a in self.all_assignments if isinstance(a, Assignment))), \
- "Not in SSA form - same symbol assigned multiple times"
-
- # TODO rewrite with SymPy AST
- # bound_symbols_set = bound_symbols_set.union(*[
- # assignment.symbols_defined for assignment in self.all_assignments
- # if isinstance(assignment, pystencils.astnodes.Node)
- # ])
-
- return bound_symbols_set
-
- @property
- def rhs_fields(self):
- """All fields accessed in the assignment collection, which do not occur as left hand sides in any assignment."""
- return {s.field for s in self.rhs_symbols if hasattr(s, 'field')}
-
- @property
- def free_fields(self):
- """All fields accessed in the assignment collection, which do not occur as left hand sides in any assignment."""
- return {s.field for s in self.free_symbols if hasattr(s, 'field')}
-
- @property
- def bound_fields(self):
- """All field accessed on the left hand side of a main assignment or a subexpression."""
- return {s.field for s in self.bound_symbols if hasattr(s, 'field')}
-
- @property
- def defined_symbols(self) -> Set[sp.Symbol]:
- """All symbols which occur as left-hand-sides of one of the main equations"""
- lhs_set = set([assignment.lhs for assignment in self.main_assignments if isinstance(assignment, Assignment)])
- return lhs_set
- # TODO rewrite with SymPy AST
- # return (lhs_set.union(*[assignment.symbols_defined for assignment in self.main_assignments
- # if isinstance(assignment, pystencils.astnodes.Node)]))
-
- @property
- def operation_count(self):
- """See :func:`count_operations` """
- return count_operations(self.all_assignments, only_type=None)
-
- def atoms(self, *args):
- return set().union(*[a.atoms(*args) for a in self.all_assignments])
-
- def dependent_symbols(self, symbols: Iterable[sp.Symbol]) -> Set[sp.Symbol]:
- """Returns all symbols that depend on one of the passed symbols.
-
- A symbol 'a' depends on a symbol 'b', if there is an assignment 'a <- some_expression(b)' i.e. when
- 'b' is required to compute 'a'.
- """
-
- queue = list(symbols)
-
- def add_symbols_from_expr(expr):
- dependent_symbols = expr.atoms(sp.Symbol)
- for ds in dependent_symbols:
- queue.append(ds)
-
- handled_symbols = set()
- assignment_dict = {e.lhs: e.rhs for e in self.all_assignments}
-
- while len(queue) > 0:
- e = queue.pop(0)
- if e in handled_symbols:
- continue
- if e in assignment_dict:
- add_symbols_from_expr(assignment_dict[e])
- handled_symbols.add(e)
-
- return handled_symbols
-
- def lambdify(self, symbols: Sequence[sp.Symbol], fixed_symbols: Optional[Dict[sp.Symbol, Any]] = None, module=None):
- """Returns a python function to evaluate this equation collection.
-
- Args:
- symbols: symbol(s) which are the parameter for the created function
- fixed_symbols: dictionary with substitutions, that are applied before sympy's lambdify
- module: same as sympy.lambdify parameter. Defines which module to use e.g. 'numpy'
-
- Examples:
- >>> a, b, c, d = sp.symbols("a b c d")
- >>> ac = AssignmentCollection([Assignment(c, a + b), Assignment(d, a**2 + b)],
- ... subexpressions=[Assignment(b, a + b / 2)])
- >>> python_function = ac.lambdify([a], fixed_symbols={b: 2})
- >>> python_function(4)
- {c: 6, d: 18}
- """
- assignments = self.new_with_substitutions(fixed_symbols, substitute_on_lhs=False) if fixed_symbols else self
- assignments = assignments.new_without_subexpressions().main_assignments
- lambdas = {assignment.lhs: sp.lambdify(symbols, assignment.rhs, module) for assignment in assignments}
-
- def f(*args, **kwargs):
- return {s: func(*args, **kwargs) for s, func in lambdas.items()}
-
- return f
-
- # ---------------------------- Creating new modified collections ---------------------------------------------------
-
- def copy(self,
- main_assignments: Optional[List[Assignment]] = None,
- subexpressions: Optional[List[Assignment]] = None) -> 'AssignmentCollection':
- """Returns a copy with optionally replaced main_assignments and/or subexpressions."""
-
- res = copy(self)
- res.simplification_hints = self.simplification_hints.copy()
- res.subexpression_symbol_generator = copy(self.subexpression_symbol_generator)
-
- if main_assignments is not None:
- res.main_assignments = main_assignments
- else:
- res.main_assignments = self.main_assignments.copy()
-
- if subexpressions is not None:
- res.subexpressions = subexpressions
- else:
- res.subexpressions = self.subexpressions.copy()
-
- return res
-
- def new_with_substitutions(self, substitutions: Dict, add_substitutions_as_subexpressions: bool = False,
- substitute_on_lhs: bool = True,
- sort_topologically: bool = True) -> 'AssignmentCollection':
- """Returns new object, where terms are substituted according to the passed substitution dict.
-
- Args:
- substitutions: dict that is passed to sympy subs, substitutions are done main assignments and subexpressions
- add_substitutions_as_subexpressions: if True, the substitutions are added as assignments to subexpressions
- substitute_on_lhs: if False, the substitutions are done only on the right hand side of assignments
- sort_topologically: if subexpressions are added as substitutions and this parameters is true,
- the subexpressions are sorted topologically after insertion
- Returns:
- New AssignmentCollection where substitutions have been applied, self is not altered.
- """
- transform = transform_lhs_and_rhs if substitute_on_lhs else transform_rhs
- transformed_subexpressions = transform(self.subexpressions, fast_subs, substitutions)
- transformed_assignments = transform(self.main_assignments, fast_subs, substitutions)
-
- if add_substitutions_as_subexpressions:
- transformed_subexpressions = [Assignment(b, a) for a, b in
- substitutions.items()] + transformed_subexpressions
- if sort_topologically:
- transformed_subexpressions = sort_assignments_topologically(transformed_subexpressions)
- return self.copy(transformed_assignments, transformed_subexpressions)
-
- def new_merged(self, other: 'AssignmentCollection') -> 'AssignmentCollection':
- """Returns a new collection which contains self and other. Subexpressions are renamed if they clash."""
- own_definitions = set([e.lhs for e in self.main_assignments])
- other_definitions = set([e.lhs for e in other.main_assignments])
- assert len(own_definitions.intersection(other_definitions)) == 0, \
- "Cannot merge collections, since both define the same symbols"
-
- own_subexpression_symbols = {e.lhs: e.rhs for e in self.subexpressions}
- substitution_dict = {}
-
- processed_other_subexpression_equations = []
- for other_subexpression_eq in other.subexpressions:
- if other_subexpression_eq.lhs in own_subexpression_symbols:
- if other_subexpression_eq.rhs == own_subexpression_symbols[other_subexpression_eq.lhs]:
- continue # exact the same subexpression equation exists already
- else:
- # different definition - a new name has to be introduced
- new_lhs = next(self.subexpression_symbol_generator)
- new_eq = Assignment(new_lhs, fast_subs(other_subexpression_eq.rhs, substitution_dict))
- processed_other_subexpression_equations.append(new_eq)
- substitution_dict[other_subexpression_eq.lhs] = new_lhs
- else:
- processed_other_subexpression_equations.append(fast_subs(other_subexpression_eq, substitution_dict))
-
- processed_other_main_assignments = [fast_subs(eq, substitution_dict) for eq in other.main_assignments]
- return self.copy(self.main_assignments + processed_other_main_assignments,
- self.subexpressions + processed_other_subexpression_equations)
-
- def new_filtered(self, symbols_to_extract: Iterable[sp.Symbol]) -> 'AssignmentCollection':
- """Extracts equations that have symbols_to_extract as left hand side, together with necessary subexpressions.
-
- Returns:
- new AssignmentCollection, self is not altered
- """
- symbols_to_extract = set(symbols_to_extract)
- dependent_symbols = self.dependent_symbols(symbols_to_extract)
- new_assignments = []
- for eq in self.all_assignments:
- if eq.lhs in symbols_to_extract:
- new_assignments.append(eq)
-
- new_sub_expr = [eq for eq in self.all_assignments
- if eq.lhs in dependent_symbols and eq.lhs not in symbols_to_extract]
- return self.copy(new_assignments, new_sub_expr)
-
- def new_without_unused_subexpressions(self) -> 'AssignmentCollection':
- """Returns new collection that only contains subexpressions required to compute the main assignments."""
- all_lhs = [eq.lhs for eq in self.main_assignments]
- return self.new_filtered(all_lhs)
-
- def new_with_inserted_subexpression(self, symbol: sp.Symbol) -> 'AssignmentCollection':
- """Eliminates the subexpression with the given symbol on its left hand side, by substituting it everywhere."""
- new_subexpressions = []
- subs_dict = None
- for se in self.subexpressions:
- if se.lhs == symbol:
- subs_dict = {se.lhs: se.rhs}
- else:
- new_subexpressions.append(se)
- if subs_dict is None:
- return self
-
- new_subexpressions = [Assignment(eq.lhs, fast_subs(eq.rhs, subs_dict)) for eq in new_subexpressions]
- new_eqs = [Assignment(eq.lhs, fast_subs(eq.rhs, subs_dict)) for eq in self.main_assignments]
- return self.copy(new_eqs, new_subexpressions)
-
- def new_without_subexpressions(self, subexpressions_to_keep=None) -> 'AssignmentCollection':
- """Returns a new collection where all subexpressions have been inserted."""
- if subexpressions_to_keep is None:
- subexpressions_to_keep = set()
- if len(self.subexpressions) == 0:
- return self.copy()
-
- subexpressions_to_keep = set(subexpressions_to_keep)
-
- kept_subexpressions = []
- if self.subexpressions[0].lhs in subexpressions_to_keep:
- substitution_dict = {}
- kept_subexpressions.append(self.subexpressions[0])
- else:
- substitution_dict = {self.subexpressions[0].lhs: self.subexpressions[0].rhs}
-
- subexpression = [e for e in self.subexpressions]
- for i in range(1, len(subexpression)):
- subexpression[i] = fast_subs(subexpression[i], substitution_dict)
- if subexpression[i].lhs in subexpressions_to_keep:
- kept_subexpressions.append(subexpression[i])
- else:
- substitution_dict[subexpression[i].lhs] = subexpression[i].rhs
-
- new_assignment = [fast_subs(eq, substitution_dict) for eq in self.main_assignments]
- return self.copy(new_assignment, kept_subexpressions)
-
- # ----------------------------------------- Display and Printing -------------------------------------------------
-
- def _repr_html_(self):
- """Interface to Jupyter notebook, to display as a nicely formatted HTML table"""
-
- def make_html_equation_table(equations):
- no_border = 'style="border:none"'
- html_table = '<table style="border:none; width: 100%; ">'
- line = '<tr {nb}> <td {nb}>$${eq}$$</td> </tr> '
- for eq in equations:
- format_dict = {'eq': sp.latex(eq),
- 'nb': no_border, }
- html_table += line.format(**format_dict)
- html_table += "</table>"
- return html_table
-
- result = ""
- if len(self.subexpressions) > 0:
- result += "<div>Subexpressions:</div>"
- result += make_html_equation_table(self.subexpressions)
- result += "<div>Main Assignments:</div>"
- result += make_html_equation_table(self.main_assignments)
- return result
-
- def __repr__(self):
- return f"AssignmentCollection: {str(tuple(self.defined_symbols))[1:-1]} <- f{tuple(self.free_symbols)}"
-
- def __str__(self):
- result = "Subexpressions:\n"
- for eq in self.subexpressions:
- result += f"\t{eq}\n"
- result += "Main Assignments:\n"
- for eq in self.main_assignments:
- result += f"\t{eq}\n"
- return result
-
- def __iter__(self):
- return self.all_assignments.__iter__()
-
- @property
- def main_assignments_dict(self):
- return {a.lhs: a.rhs for a in self.main_assignments}
-
- @property
- def subexpressions_dict(self):
- return {a.lhs: a.rhs for a in self.subexpressions}
-
- def set_main_assignments_from_dict(self, main_assignments_dict):
- self.main_assignments = [Assignment(k, v)
- for k, v in main_assignments_dict.items()]
-
- def set_sub_expressions_from_dict(self, sub_expressions_dict):
- self.subexpressions = [Assignment(k, v)
- for k, v in sub_expressions_dict.items()]
-
- def find(self, *args, **kwargs):
- return set.union(
- *[a.find(*args, **kwargs) for a in self.all_assignments]
- )
-
- def match(self, *args, **kwargs):
- rtn = {}
- for a in self.all_assignments:
- partial_result = a.match(*args, **kwargs)
- if partial_result:
- rtn.update(partial_result)
- return rtn
-
- def subs(self, *args, **kwargs):
- return AssignmentCollection(
- main_assignments=[a.subs(*args, **kwargs) for a in self.main_assignments],
- subexpressions=[a.subs(*args, **kwargs) for a in self.subexpressions]
- )
-
- def replace(self, *args, **kwargs):
- return AssignmentCollection(
- main_assignments=[a.replace(*args, **kwargs) for a in self.main_assignments],
- subexpressions=[a.replace(*args, **kwargs) for a in self.subexpressions]
- )
-
- def __eq__(self, other):
- return set(self.all_assignments) == set(other.all_assignments)
-
- def __bool__(self):
- return bool(self.all_assignments)
-
-
-class SymbolGen:
- """Default symbol generator producing number symbols ζ_0, ζ_1, ..."""
-
- def __init__(self, symbol="xi", dtype=None, ctr=0):
- self._ctr = ctr
- self._symbol = symbol
- self._dtype = dtype
-
- def __iter__(self):
- return self
-
- def __next__(self):
- name = f"{self._symbol}_{self._ctr}"
- self._ctr += 1
- if self._dtype is not None:
- return TypedSymbol(name, self._dtype)
- return sp.Symbol(name)
-
-
-def get_dummy_symbol(dtype='bool'):
- return TypedSymbol(f'dummy{uuid.uuid4().hex}', create_type(dtype))
class ConditionalFieldAccess(sp.Function):
@@ -618,6 +30,8 @@ class ConditionalFieldAccess(sp.Function):
def generic_visit(term, visitor):
+ from pystencils import AssignmentCollection, Assignment
+
if isinstance(term, AssignmentCollection):
new_main_assignments = generic_visit(term.main_assignments, visitor)
new_subexpressions = generic_visit(term.subexpressions, visitor)
diff --git a/src/pystencils/sympyextensions/fast_approximation.py b/src/pystencils/sympyextensions/fast_approximation.py
index 9088348fb3ff45d36d2f02d0ac7c2244a3d51c03..d9656025e7c69217e2f82eeacdea8c1fe872db8a 100644
--- a/src/pystencils/sympyextensions/fast_approximation.py
+++ b/src/pystencils/sympyextensions/fast_approximation.py
@@ -2,7 +2,8 @@ from typing import List, Union
import sympy as sp
-from pystencils.sympyextensions import AssignmentCollection, Assignment
+from ..assignment import Assignment
+from ..simp import AssignmentCollection
# noinspection PyPep8Naming
diff --git a/src/pystencils/sympyextensions/math.py b/src/pystencils/sympyextensions/math.py
index a2df9458e5038e8ab088f223058fa6f77d893593..1a006efe6cb95ec7196476387f49094a1a8ee9c5 100644
--- a/src/pystencils/sympyextensions/math.py
+++ b/src/pystencils/sympyextensions/math.py
@@ -10,7 +10,7 @@ from sympy import PolynomialError
from sympy.functions import Abs
from sympy.core.numbers import Zero
-from .astnodes import Assignment
+from ..assignment import Assignment
from .typed_sympy import CastFunc, FieldPointerSymbol
from ..types import PsPointerType, PsVectorType
diff --git a/tests/nbackend/kernelcreation/test_domain_kernels.py b/tests/nbackend/kernelcreation/test_domain_kernels.py
index 9ce2f661d840641d28774134070fc7050e90e6d1..c9cc81abbe988be4d9c92dc1d833260f38691433 100644
--- a/tests/nbackend/kernelcreation/test_domain_kernels.py
+++ b/tests/nbackend/kernelcreation/test_domain_kernels.py
@@ -2,7 +2,7 @@ import sympy as sp
import numpy as np
from pystencils import fields, Field, AssignmentCollection
-from pystencils.sympyextensions.astnodes import assignment_from_stencil
+from pystencils.assignment import assignment_from_stencil
from pystencils.kernelcreation import create_kernel
diff --git a/tests/symbolics/test_address_of.py b/tests/symbolics/test_address_of.py
index da11ecbe5374b95801f2de027b4db4df9e2fa04d..99f33ddbdfa7054bf5f27c08848640ee03f64555 100644
--- a/tests/symbolics/test_address_of.py
+++ b/tests/symbolics/test_address_of.py
@@ -6,7 +6,7 @@ import pystencils
from pystencils.types import PsPointerType, create_type
from pystencils.sympyextensions.pointers import AddressOf
from pystencils.sympyextensions.typed_sympy import CastFunc
-from pystencils.sympyextensions import sympy_cse
+from pystencils.simp import sympy_cse
import sympy as sp
diff --git a/tests/symbolics/test_conditional_field_access.py b/tests/symbolics/test_conditional_field_access.py
index bd384a95948511ede2d65222b69a81479c717a30..e18ffc56a4b0a95c30ff2e9e2d4affa5567654ac 100644
--- a/tests/symbolics/test_conditional_field_access.py
+++ b/tests/symbolics/test_conditional_field_access.py
@@ -16,7 +16,7 @@ import sympy as sp
import pystencils as ps
from pystencils import Field, x_vector
from pystencils.sympyextensions.astnodes import ConditionalFieldAccess
-from pystencils.sympyextensions import sympy_cse
+from pystencils.simp import sympy_cse
def add_fixed_constant_boundary_handling(assignments, with_cse):
diff --git a/tests/test_assignment_collection.py b/tests/test_assignment_collection.py
index ced0a36e1a0b4d62aaf5549b0d82dd909ddd8124..797465ecad0c7b649e4b76078baa72cc8f66c216 100644
--- a/tests/test_assignment_collection.py
+++ b/tests/test_assignment_collection.py
@@ -170,3 +170,19 @@ def test_new_merged():
assert ps.Assignment(d[0, 0](0), sp.symbols('xi_0')) in merged_ac.main_assignments
assert a1 in merged_ac.subexpressions
assert a3 in merged_ac.subexpressions
+
+ a1 = ps.Assignment(a, 20)
+ a2 = ps.Assignment(a, 10)
+ acommon = ps.Assignment(b, a)
+
+ # main assignments
+ a3 = ps.Assignment(f[0, 0](0), b)
+ a4 = ps.Assignment(d[0, 0](0), b)
+
+ ac = ps.AssignmentCollection([a3], subexpressions=[a1, acommon])
+ ac2 = ps.AssignmentCollection([a4], subexpressions=[a2, acommon])
+
+ merged_ac = ac.new_merged(ac2).new_without_subexpressions()
+
+ assert ps.Assignment(f[0, 0](0), 20) in merged_ac.main_assignments
+ assert ps.Assignment(d[0, 0](0), 10) in merged_ac.main_assignments
diff --git a/tests/test_fvm.py b/tests/test_fvm.py
index e10874cbdf27abe161510e57242f1232f60a6d53..0b103e52554f767a0948509e8cae084c1af9e124 100644
--- a/tests/test_fvm.py
+++ b/tests/test_fvm.py
@@ -3,7 +3,7 @@ import pystencils as ps
import numpy as np
import pytest
from itertools import product
-from pystencils.sympyextensions.rng import random_symbol
+from pystencils.rng import random_symbol
from pystencils.sympyextensions.astnodes import SympyAssignment
from pystencils.node_collection import NodeCollection
diff --git a/tests/test_random.py b/tests/test_random.py
index 6c3a888db86ff7e3b3ed100961643e3cdf36231b..63cd61494b675acbc1675277ff9eb9b1f57ddb3e 100644
--- a/tests/test_random.py
+++ b/tests/test_random.py
@@ -5,7 +5,7 @@ import pytest
import pystencils as ps
from pystencils.sympyextensions.astnodes import SympyAssignment
from pystencils.node_collection import NodeCollection
-from pystencils.sympyextensions.rng import PhiloxFourFloats, PhiloxTwoDoubles, AESNIFourFloats, AESNITwoDoubles, random_symbol
+from pystencils.rng import PhiloxFourFloats, PhiloxTwoDoubles, AESNIFourFloats, AESNITwoDoubles, random_symbol
from pystencils.backends.simd_instruction_sets import get_supported_instruction_sets
from pystencils.cpu.cpujit import get_compiler_config
from pystencils.typing import TypedSymbol
diff --git a/versioneer.py b/versioneer.py
deleted file mode 100644
index 1040c218924c06a246ea1bd872201a5c57744192..0000000000000000000000000000000000000000
--- a/versioneer.py
+++ /dev/null
@@ -1,1855 +0,0 @@
-
-# Version: 0.19
-
-"""The Versioneer - like a rocketeer, but for versions.
-
-The Versioneer
-==============
-
-* like a rocketeer, but for versions!
-* https://github.com/python-versioneer/python-versioneer
-* Brian Warner
-* License: Public Domain
-* Compatible with: Python 3.6, 3.7, 3.8, 3.9 and pypy3
-* [![Latest Version][pypi-image]][pypi-url]
-* [![Build Status][travis-image]][travis-url]
-
-This is a tool for managing a recorded version number in distutils-based
-python projects. The goal is to remove the tedious and error-prone "update
-the embedded version string" step from your release process. Making a new
-release should be as easy as recording a new tag in your version-control
-system, and maybe making new tarballs.
-
-
-## Quick Install
-
-* `pip install versioneer` to somewhere in your $PATH
-* add a `[versioneer]` section to your setup.cfg (see [Install](INSTALL.md))
-* run `versioneer install` in your source tree, commit the results
-* Verify version information with `python setup.py version`
-
-## Version Identifiers
-
-Source trees come from a variety of places:
-
-* a version-control system checkout (mostly used by developers)
-* a nightly tarball, produced by build automation
-* a snapshot tarball, produced by a web-based VCS browser, like github's
- "tarball from tag" feature
-* a release tarball, produced by "setup.py sdist", distributed through PyPI
-
-Within each source tree, the version identifier (either a string or a number,
-this tool is format-agnostic) can come from a variety of places:
-
-* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows
- about recent "tags" and an absolute revision-id
-* the name of the directory into which the tarball was unpacked
-* an expanded VCS keyword ($Id$, etc)
-* a `_version.py` created by some earlier build step
-
-For released software, the version identifier is closely related to a VCS
-tag. Some projects use tag names that include more than just the version
-string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool
-needs to strip the tag prefix to extract the version identifier. For
-unreleased software (between tags), the version identifier should provide
-enough information to help developers recreate the same tree, while also
-giving them an idea of roughly how old the tree is (after version 1.2, before
-version 1.3). Many VCS systems can report a description that captures this,
-for example `git describe --tags --dirty --always` reports things like
-"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the
-0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has
-uncommitted changes).
-
-The version identifier is used for multiple purposes:
-
-* to allow the module to self-identify its version: `myproject.__version__`
-* to choose a name and prefix for a 'setup.py sdist' tarball
-
-## Theory of Operation
-
-Versioneer works by adding a special `_version.py` file into your source
-tree, where your `__init__.py` can import it. This `_version.py` knows how to
-dynamically ask the VCS tool for version information at import time.
-
-`_version.py` also contains `$Revision$` markers, and the installation
-process marks `_version.py` to have this marker rewritten with a tag name
-during the `git archive` command. As a result, generated tarballs will
-contain enough information to get the proper version.
-
-To allow `setup.py` to compute a version too, a `versioneer.py` is added to
-the top level of your source tree, next to `setup.py` and the `setup.cfg`
-that configures it. This overrides several distutils/setuptools commands to
-compute the version when invoked, and changes `setup.py build` and `setup.py
-sdist` to replace `_version.py` with a small static file that contains just
-the generated version data.
-
-## Installation
-
-See [INSTALL.md](./INSTALL.md) for detailed installation instructions.
-
-## Version-String Flavors
-
-Code which uses Versioneer can learn about its version string at runtime by
-importing `_version` from your main `__init__.py` file and running the
-`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can
-import the top-level `versioneer.py` and run `get_versions()`.
-
-Both functions return a dictionary with different flavors of version
-information:
-
-* `['version']`: A condensed version string, rendered using the selected
- style. This is the most commonly used value for the project's version
- string. The default "pep440" style yields strings like `0.11`,
- `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section
- below for alternative styles.
-
-* `['full-revisionid']`: detailed revision identifier. For Git, this is the
- full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac".
-
-* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the
- commit date in ISO 8601 format. This will be None if the date is not
- available.
-
-* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that
- this is only accurate if run in a VCS checkout, otherwise it is likely to
- be False or None
-
-* `['error']`: if the version string could not be computed, this will be set
- to a string describing the problem, otherwise it will be None. It may be
- useful to throw an exception in setup.py if this is set, to avoid e.g.
- creating tarballs with a version string of "unknown".
-
-Some variants are more useful than others. Including `full-revisionid` in a
-bug report should allow developers to reconstruct the exact code being tested
-(or indicate the presence of local changes that should be shared with the
-developers). `version` is suitable for display in an "about" box or a CLI
-`--version` output: it can be easily compared against release notes and lists
-of bugs fixed in various releases.
-
-The installer adds the following text to your `__init__.py` to place a basic
-version in `YOURPROJECT.__version__`:
-
- from ._version import get_versions
- __version__ = get_versions()['version']
- del get_versions
-
-## Styles
-
-The setup.cfg `style=` configuration controls how the VCS information is
-rendered into a version string.
-
-The default style, "pep440", produces a PEP440-compliant string, equal to the
-un-prefixed tag name for actual releases, and containing an additional "local
-version" section with more detail for in-between builds. For Git, this is
-TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags
---dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the
-tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and
-that this commit is two revisions ("+2") beyond the "0.11" tag. For released
-software (exactly equal to a known tag), the identifier will only contain the
-stripped tag, e.g. "0.11".
-
-Other styles are available. See [details.md](details.md) in the Versioneer
-source tree for descriptions.
-
-## Debugging
-
-Versioneer tries to avoid fatal errors: if something goes wrong, it will tend
-to return a version of "0+unknown". To investigate the problem, run `setup.py
-version`, which will run the version-lookup code in a verbose mode, and will
-display the full contents of `get_versions()` (including the `error` string,
-which may help identify what went wrong).
-
-## Known Limitations
-
-Some situations are known to cause problems for Versioneer. This details the
-most significant ones. More can be found on Github
-[issues page](https://github.com/python-versioneer/python-versioneer/issues).
-
-### Subprojects
-
-Versioneer has limited support for source trees in which `setup.py` is not in
-the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are
-two common reasons why `setup.py` might not be in the root:
-
-* Source trees which contain multiple subprojects, such as
- [Buildbot](https://github.com/buildbot/buildbot), which contains both
- "master" and "slave" subprojects, each with their own `setup.py`,
- `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI
- distributions (and upload multiple independently-installable tarballs).
-* Source trees whose main purpose is to contain a C library, but which also
- provide bindings to Python (and perhaps other languages) in subdirectories.
-
-Versioneer will look for `.git` in parent directories, and most operations
-should get the right version string. However `pip` and `setuptools` have bugs
-and implementation details which frequently cause `pip install .` from a
-subproject directory to fail to find a correct version string (so it usually
-defaults to `0+unknown`).
-
-`pip install --editable .` should work correctly. `setup.py install` might
-work too.
-
-Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in
-some later version.
-
-[Bug #38](https://github.com/python-versioneer/python-versioneer/issues/38) is tracking
-this issue. The discussion in
-[PR #61](https://github.com/python-versioneer/python-versioneer/pull/61) describes the
-issue from the Versioneer side in more detail.
-[pip PR#3176](https://github.com/pypa/pip/pull/3176) and
-[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve
-pip to let Versioneer work correctly.
-
-Versioneer-0.16 and earlier only looked for a `.git` directory next to the
-`setup.cfg`, so subprojects were completely unsupported with those releases.
-
-### Editable installs with setuptools <= 18.5
-
-`setup.py develop` and `pip install --editable .` allow you to install a
-project into a virtualenv once, then continue editing the source code (and
-test) without re-installing after every change.
-
-"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a
-convenient way to specify executable scripts that should be installed along
-with the python package.
-
-These both work as expected when using modern setuptools. When using
-setuptools-18.5 or earlier, however, certain operations will cause
-`pkg_resources.DistributionNotFound` errors when running the entrypoint
-script, which must be resolved by re-installing the package. This happens
-when the install happens with one version, then the egg_info data is
-regenerated while a different version is checked out. Many setup.py commands
-cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into
-a different virtualenv), so this can be surprising.
-
-[Bug #83](https://github.com/python-versioneer/python-versioneer/issues/83) describes
-this one, but upgrading to a newer version of setuptools should probably
-resolve it.
-
-
-## Updating Versioneer
-
-To upgrade your project to a new release of Versioneer, do the following:
-
-* install the new Versioneer (`pip install -U versioneer` or equivalent)
-* edit `setup.cfg`, if necessary, to include any new configuration settings
- indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details.
-* re-run `versioneer install` in your source tree, to replace
- `SRC/_version.py`
-* commit any changed files
-
-## Future Directions
-
-This tool is designed to make it easily extended to other version-control
-systems: all VCS-specific components are in separate directories like
-src/git/ . The top-level `versioneer.py` script is assembled from these
-components by running make-versioneer.py . In the future, make-versioneer.py
-will take a VCS name as an argument, and will construct a version of
-`versioneer.py` that is specific to the given VCS. It might also take the
-configuration arguments that are currently provided manually during
-installation by editing setup.py . Alternatively, it might go the other
-direction and include code from all supported VCS systems, reducing the
-number of intermediate scripts.
-
-## Similar projects
-
-* [setuptools_scm](https://github.com/pypa/setuptools_scm/) - a non-vendored build-time
- dependency
-* [minver](https://github.com/jbweston/miniver) - a lightweight reimplementation of
- versioneer
-
-## License
-
-To make Versioneer easier to embed, all its code is dedicated to the public
-domain. The `_version.py` that it creates is also in the public domain.
-Specifically, both are released under the Creative Commons "Public Domain
-Dedication" license (CC0-1.0), as described in
-https://creativecommons.org/publicdomain/zero/1.0/ .
-
-[pypi-image]: https://img.shields.io/pypi/v/versioneer.svg
-[pypi-url]: https://pypi.python.org/pypi/versioneer/
-[travis-image]:
-https://img.shields.io/travis/com/python-versioneer/python-versioneer.svg
-[travis-url]: https://travis-ci.com/github/python-versioneer/python-versioneer
-
-"""
-
-import configparser
-import errno
-import json
-import os
-import re
-import subprocess
-import sys
-
-
-class VersioneerConfig:
- """Container for Versioneer configuration parameters."""
-
-
-def get_root():
- """Get the project root directory.
-
- We require that all commands are run from the project root, i.e. the
- directory that contains setup.py, setup.cfg, and versioneer.py .
- """
- root = os.path.realpath(os.path.abspath(os.getcwd()))
- setup_py = os.path.join(root, "setup.py")
- versioneer_py = os.path.join(root, "versioneer.py")
- if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)):
- # allow 'python path/to/setup.py COMMAND'
- root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0])))
- setup_py = os.path.join(root, "setup.py")
- versioneer_py = os.path.join(root, "versioneer.py")
- if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)):
- err = ("Versioneer was unable to run the project root directory. "
- "Versioneer requires setup.py to be executed from "
- "its immediate directory (like 'python setup.py COMMAND'), "
- "or in a way that lets it use sys.argv[0] to find the root "
- "(like 'python path/to/setup.py COMMAND').")
- raise VersioneerBadRootError(err)
- try:
- # Certain runtime workflows (setup.py install/develop in a setuptools
- # tree) execute all dependencies in a single python process, so
- # "versioneer" may be imported multiple times, and python's shared
- # module-import table will cache the first one. So we can't use
- # os.path.dirname(__file__), as that will find whichever
- # versioneer.py was first imported, even in later projects.
- me = os.path.realpath(os.path.abspath(__file__))
- me_dir = os.path.normcase(os.path.splitext(me)[0])
- vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0])
- if me_dir != vsr_dir:
- print("Warning: build in %s is using versioneer.py from %s"
- % (os.path.dirname(me), versioneer_py))
- except NameError:
- pass
- return root
-
-
-def get_config_from_root(root):
- """Read the project setup.cfg file to determine Versioneer config."""
- # This might raise EnvironmentError (if setup.cfg is missing), or
- # configparser.NoSectionError (if it lacks a [versioneer] section), or
- # configparser.NoOptionError (if it lacks "VCS="). See the docstring at
- # the top of versioneer.py for instructions on writing your setup.cfg .
- setup_cfg = os.path.join(root, "setup.cfg")
- parser = configparser.ConfigParser()
- with open(setup_cfg, "r") as f:
- parser.read_file(f)
- VCS = parser.get("versioneer", "VCS") # mandatory
-
- def get(parser, name):
- if parser.has_option("versioneer", name):
- return parser.get("versioneer", name)
- return None
- cfg = VersioneerConfig()
- cfg.VCS = VCS
- cfg.style = get(parser, "style") or ""
- cfg.versionfile_source = get(parser, "versionfile_source")
- cfg.versionfile_build = get(parser, "versionfile_build")
- cfg.tag_prefix = get(parser, "tag_prefix")
- if cfg.tag_prefix in ("''", '""'):
- cfg.tag_prefix = ""
- cfg.parentdir_prefix = get(parser, "parentdir_prefix")
- cfg.verbose = get(parser, "verbose")
- return cfg
-
-
-class NotThisMethod(Exception):
- """Exception raised if a method is not valid for the current scenario."""
-
-
-# these dictionaries contain VCS-specific tools
-LONG_VERSION_PY = {}
-HANDLERS = {}
-
-
-def register_vcs_handler(vcs, method): # decorator
- """Create decorator to mark a method as the handler of a VCS."""
- def decorate(f):
- """Store f in HANDLERS[vcs][method]."""
- if vcs not in HANDLERS:
- HANDLERS[vcs] = {}
- HANDLERS[vcs][method] = f
- return f
- return decorate
-
-
-def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
- env=None):
- """Call the given command(s)."""
- assert isinstance(commands, list)
- p = None
- for c in commands:
- try:
- dispcmd = str([c] + args)
- # remember shell=False, so use git.cmd on windows, not just git
- p = subprocess.Popen([c] + args, cwd=cwd, env=env,
- stdout=subprocess.PIPE,
- stderr=(subprocess.PIPE if hide_stderr
- else None))
- break
- except EnvironmentError:
- e = sys.exc_info()[1]
- if e.errno == errno.ENOENT:
- continue
- if verbose:
- print("unable to run %s" % dispcmd)
- print(e)
- return None, None
- else:
- if verbose:
- print("unable to find command, tried %s" % (commands,))
- return None, None
- stdout = p.communicate()[0].strip().decode()
- if p.returncode != 0:
- if verbose:
- print("unable to run %s (error)" % dispcmd)
- print("stdout was %s" % stdout)
- return None, p.returncode
- return stdout, p.returncode
-
-
-LONG_VERSION_PY['git'] = r'''
-# This file helps to compute a version number in source trees obtained from
-# git-archive tarball (such as those provided by githubs download-from-tag
-# feature). Distribution tarballs (built by setup.py sdist) and build
-# directories (produced by setup.py build) will contain a much shorter file
-# that just contains the computed version number.
-
-# This file is released into the public domain. Generated by
-# versioneer-0.19 (https://github.com/python-versioneer/python-versioneer)
-
-"""Git implementation of _version.py."""
-
-import errno
-import os
-import re
-import subprocess
-import sys
-
-
-def get_keywords():
- """Get the keywords needed to look up the version information."""
- # these strings will be replaced by git during git-archive.
- # setup.py/versioneer.py will grep for the variable names, so they must
- # each be defined on a line of their own. _version.py will just call
- # get_keywords().
- git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s"
- git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s"
- git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s"
- keywords = {"refnames": git_refnames, "full": git_full, "date": git_date}
- return keywords
-
-
-class VersioneerConfig:
- """Container for Versioneer configuration parameters."""
-
-
-def get_config():
- """Create, populate and return the VersioneerConfig() object."""
- # these strings are filled in when 'setup.py versioneer' creates
- # _version.py
- cfg = VersioneerConfig()
- cfg.VCS = "git"
- cfg.style = "%(STYLE)s"
- cfg.tag_prefix = "%(TAG_PREFIX)s"
- cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s"
- cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s"
- cfg.verbose = False
- return cfg
-
-
-class NotThisMethod(Exception):
- """Exception raised if a method is not valid for the current scenario."""
-
-
-LONG_VERSION_PY = {}
-HANDLERS = {}
-
-
-def register_vcs_handler(vcs, method): # decorator
- """Create decorator to mark a method as the handler of a VCS."""
- def decorate(f):
- """Store f in HANDLERS[vcs][method]."""
- if vcs not in HANDLERS:
- HANDLERS[vcs] = {}
- HANDLERS[vcs][method] = f
- return f
- return decorate
-
-
-def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False,
- env=None):
- """Call the given command(s)."""
- assert isinstance(commands, list)
- p = None
- for c in commands:
- try:
- dispcmd = str([c] + args)
- # remember shell=False, so use git.cmd on windows, not just git
- p = subprocess.Popen([c] + args, cwd=cwd, env=env,
- stdout=subprocess.PIPE,
- stderr=(subprocess.PIPE if hide_stderr
- else None))
- break
- except EnvironmentError:
- e = sys.exc_info()[1]
- if e.errno == errno.ENOENT:
- continue
- if verbose:
- print("unable to run %%s" %% dispcmd)
- print(e)
- return None, None
- else:
- if verbose:
- print("unable to find command, tried %%s" %% (commands,))
- return None, None
- stdout = p.communicate()[0].strip().decode()
- if p.returncode != 0:
- if verbose:
- print("unable to run %%s (error)" %% dispcmd)
- print("stdout was %%s" %% stdout)
- return None, p.returncode
- return stdout, p.returncode
-
-
-def versions_from_parentdir(parentdir_prefix, root, verbose):
- """Try to determine the version from the parent directory name.
-
- Source tarballs conventionally unpack into a directory that includes both
- the project name and a version string. We will also support searching up
- two directory levels for an appropriately named parent directory
- """
- rootdirs = []
-
- for i in range(3):
- dirname = os.path.basename(root)
- if dirname.startswith(parentdir_prefix):
- return {"version": dirname[len(parentdir_prefix):],
- "full-revisionid": None,
- "dirty": False, "error": None, "date": None}
- else:
- rootdirs.append(root)
- root = os.path.dirname(root) # up a level
-
- if verbose:
- print("Tried directories %%s but none started with prefix %%s" %%
- (str(rootdirs), parentdir_prefix))
- raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
-
-
-@register_vcs_handler("git", "get_keywords")
-def git_get_keywords(versionfile_abs):
- """Extract version information from the given file."""
- # the code embedded in _version.py can just fetch the value of these
- # keywords. When used from setup.py, we don't want to import _version.py,
- # so we do it with a regexp instead. This function is not used from
- # _version.py.
- keywords = {}
- try:
- f = open(versionfile_abs, "r")
- for line in f.readlines():
- if line.strip().startswith("git_refnames ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["refnames"] = mo.group(1)
- if line.strip().startswith("git_full ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["full"] = mo.group(1)
- if line.strip().startswith("git_date ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["date"] = mo.group(1)
- f.close()
- except EnvironmentError:
- pass
- return keywords
-
-
-@register_vcs_handler("git", "keywords")
-def git_versions_from_keywords(keywords, tag_prefix, verbose):
- """Get version information from git keywords."""
- if not keywords:
- raise NotThisMethod("no keywords at all, weird")
- date = keywords.get("date")
- if date is not None:
- # Use only the last line. Previous lines may contain GPG signature
- # information.
- date = date.splitlines()[-1]
-
- # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant
- # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601
- # -like" string, which we must then edit to make compliant), because
- # it's been around since git-1.5.3, and it's too difficult to
- # discover which version we're using, or to work around using an
- # older one.
- date = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
- refnames = keywords["refnames"].strip()
- if refnames.startswith("$Format"):
- if verbose:
- print("keywords are unexpanded, not using")
- raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
- refs = set([r.strip() for r in refnames.strip("()").split(",")])
- # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
- # just "foo-1.0". If we see a "tag: " prefix, prefer those.
- TAG = "tag: "
- tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
- if not tags:
- # Either we're using git < 1.8.3, or there really are no tags. We use
- # a heuristic: assume all version tags have a digit. The old git %%d
- # expansion behaves like git log --decorate=short and strips out the
- # refs/heads/ and refs/tags/ prefixes that would let us distinguish
- # between branches and tags. By ignoring refnames without digits, we
- # filter out many common branch names like "release" and
- # "stabilization", as well as "HEAD" and "master".
- tags = set([r for r in refs if re.search(r'\d', r)])
- if verbose:
- print("discarding '%%s', no digits" %% ",".join(refs - tags))
- if verbose:
- print("likely tags: %%s" %% ",".join(sorted(tags)))
- for ref in sorted(tags):
- # sorting will prefer e.g. "2.0" over "2.0rc1"
- if ref.startswith(tag_prefix):
- r = ref[len(tag_prefix):]
- if verbose:
- print("picking %%s" %% r)
- return {"version": r,
- "full-revisionid": keywords["full"].strip(),
- "dirty": False, "error": None,
- "date": date}
- # no suitable tags, so version is "0+unknown", but full hex is still there
- if verbose:
- print("no suitable tags, using unknown + full revision id")
- return {"version": "0+unknown",
- "full-revisionid": keywords["full"].strip(),
- "dirty": False, "error": "no suitable tags", "date": None}
-
-
-@register_vcs_handler("git", "pieces_from_vcs")
-def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
- """Get version from 'git describe' in the root of the source tree.
-
- This only gets called if the git-archive 'subst' keywords were *not*
- expanded, and _version.py hasn't already been rewritten with a short
- version string, meaning we're inside a checked out source tree.
- """
- GITS = ["git"]
- if sys.platform == "win32":
- GITS = ["git.cmd", "git.exe"]
-
- out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root,
- hide_stderr=True)
- if rc != 0:
- if verbose:
- print("Directory %%s not under git control" %% root)
- raise NotThisMethod("'git rev-parse --git-dir' returned error")
-
- # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
- # if there isn't one, this yields HEX[-dirty] (no NUM)
- describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty",
- "--always", "--long",
- "--match", "%%s*" %% tag_prefix],
- cwd=root)
- # --long was added in git-1.5.5
- if describe_out is None:
- raise NotThisMethod("'git describe' failed")
- describe_out = describe_out.strip()
- full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
- if full_out is None:
- raise NotThisMethod("'git rev-parse' failed")
- full_out = full_out.strip()
-
- pieces = {}
- pieces["long"] = full_out
- pieces["short"] = full_out[:7] # maybe improved later
- pieces["error"] = None
-
- # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
- # TAG might have hyphens.
- git_describe = describe_out
-
- # look for -dirty suffix
- dirty = git_describe.endswith("-dirty")
- pieces["dirty"] = dirty
- if dirty:
- git_describe = git_describe[:git_describe.rindex("-dirty")]
-
- # now we have TAG-NUM-gHEX or HEX
-
- if "-" in git_describe:
- # TAG-NUM-gHEX
- mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
- if not mo:
- # unparseable. Maybe git-describe is misbehaving?
- pieces["error"] = ("unable to parse git-describe output: '%%s'"
- %% describe_out)
- return pieces
-
- # tag
- full_tag = mo.group(1)
- if not full_tag.startswith(tag_prefix):
- if verbose:
- fmt = "tag '%%s' doesn't start with prefix '%%s'"
- print(fmt %% (full_tag, tag_prefix))
- pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'"
- %% (full_tag, tag_prefix))
- return pieces
- pieces["closest-tag"] = full_tag[len(tag_prefix):]
-
- # distance: number of commits since tag
- pieces["distance"] = int(mo.group(2))
-
- # commit: short hex revision ID
- pieces["short"] = mo.group(3)
-
- else:
- # HEX: no tags
- pieces["closest-tag"] = None
- count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"],
- cwd=root)
- pieces["distance"] = int(count_out) # total number of commits
-
- # commit date: see ISO-8601 comment in git_versions_from_keywords()
- date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"],
- cwd=root)[0].strip()
- # Use only the last line. Previous lines may contain GPG signature
- # information.
- date = date.splitlines()[-1]
- pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
-
- return pieces
-
-
-def plus_or_dot(pieces):
- """Return a + if we don't already have one, else return a ."""
- if "+" in pieces.get("closest-tag", ""):
- return "."
- return "+"
-
-
-def render_pep440(pieces):
- """Build up version string, with post-release "local version identifier".
-
- Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
- get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
-
- Exceptions:
- 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"] or pieces["dirty"]:
- rendered += plus_or_dot(pieces)
- rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"])
- if pieces["dirty"]:
- rendered += ".dirty"
- else:
- # exception #1
- rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"],
- pieces["short"])
- if pieces["dirty"]:
- rendered += ".dirty"
- return rendered
-
-
-def render_pep440_pre(pieces):
- """TAG[.post0.devDISTANCE] -- No -dirty.
-
- Exceptions:
- 1: no tags. 0.post0.devDISTANCE
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"]:
- rendered += ".post0.dev%%d" %% pieces["distance"]
- else:
- # exception #1
- rendered = "0.post0.dev%%d" %% pieces["distance"]
- return rendered
-
-
-def render_pep440_post(pieces):
- """TAG[.postDISTANCE[.dev0]+gHEX] .
-
- The ".dev0" means dirty. Note that .dev0 sorts backwards
- (a dirty tree will appear "older" than the corresponding clean one),
- but you shouldn't be releasing software with -dirty anyways.
-
- Exceptions:
- 1: no tags. 0.postDISTANCE[.dev0]
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"] or pieces["dirty"]:
- rendered += ".post%%d" %% pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- rendered += plus_or_dot(pieces)
- rendered += "g%%s" %% pieces["short"]
- else:
- # exception #1
- rendered = "0.post%%d" %% pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- rendered += "+g%%s" %% pieces["short"]
- return rendered
-
-
-def render_pep440_old(pieces):
- """TAG[.postDISTANCE[.dev0]] .
-
- The ".dev0" means dirty.
-
- Exceptions:
- 1: no tags. 0.postDISTANCE[.dev0]
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"] or pieces["dirty"]:
- rendered += ".post%%d" %% pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- else:
- # exception #1
- rendered = "0.post%%d" %% pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- return rendered
-
-
-def render_git_describe(pieces):
- """TAG[-DISTANCE-gHEX][-dirty].
-
- Like 'git describe --tags --dirty --always'.
-
- Exceptions:
- 1: no tags. HEX[-dirty] (note: no 'g' prefix)
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"]:
- rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"])
- else:
- # exception #1
- rendered = pieces["short"]
- if pieces["dirty"]:
- rendered += "-dirty"
- return rendered
-
-
-def render_git_describe_long(pieces):
- """TAG-DISTANCE-gHEX[-dirty].
-
- Like 'git describe --tags --dirty --always -long'.
- The distance/hash is unconditional.
-
- Exceptions:
- 1: no tags. HEX[-dirty] (note: no 'g' prefix)
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"])
- else:
- # exception #1
- rendered = pieces["short"]
- if pieces["dirty"]:
- rendered += "-dirty"
- return rendered
-
-
-def render(pieces, style):
- """Render the given version pieces into the requested style."""
- if pieces["error"]:
- return {"version": "unknown",
- "full-revisionid": pieces.get("long"),
- "dirty": None,
- "error": pieces["error"],
- "date": None}
-
- if not style or style == "default":
- style = "pep440" # the default
-
- if style == "pep440":
- rendered = render_pep440(pieces)
- elif style == "pep440-pre":
- rendered = render_pep440_pre(pieces)
- elif style == "pep440-post":
- rendered = render_pep440_post(pieces)
- elif style == "pep440-old":
- rendered = render_pep440_old(pieces)
- elif style == "git-describe":
- rendered = render_git_describe(pieces)
- elif style == "git-describe-long":
- rendered = render_git_describe_long(pieces)
- else:
- raise ValueError("unknown style '%%s'" %% style)
-
- return {"version": rendered, "full-revisionid": pieces["long"],
- "dirty": pieces["dirty"], "error": None,
- "date": pieces.get("date")}
-
-
-def get_versions():
- """Get version information or return default if unable to do so."""
- # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
- # __file__, we can work backwards from there to the root. Some
- # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
- # case we can only use expanded keywords.
-
- cfg = get_config()
- verbose = cfg.verbose
-
- try:
- return git_versions_from_keywords(get_keywords(), cfg.tag_prefix,
- verbose)
- except NotThisMethod:
- pass
-
- try:
- root = os.path.realpath(__file__)
- # versionfile_source is the relative path from the top of the source
- # tree (where the .git directory might live) to this file. Invert
- # this to find the root from __file__.
- for i in cfg.versionfile_source.split('/'):
- root = os.path.dirname(root)
- except NameError:
- return {"version": "0+unknown", "full-revisionid": None,
- "dirty": None,
- "error": "unable to find root of source tree",
- "date": None}
-
- try:
- pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose)
- return render(pieces, cfg.style)
- except NotThisMethod:
- pass
-
- try:
- if cfg.parentdir_prefix:
- return versions_from_parentdir(cfg.parentdir_prefix, root, verbose)
- except NotThisMethod:
- pass
-
- return {"version": "0+unknown", "full-revisionid": None,
- "dirty": None,
- "error": "unable to compute version", "date": None}
-'''
-
-
-@register_vcs_handler("git", "get_keywords")
-def git_get_keywords(versionfile_abs):
- """Extract version information from the given file."""
- # the code embedded in _version.py can just fetch the value of these
- # keywords. When used from setup.py, we don't want to import _version.py,
- # so we do it with a regexp instead. This function is not used from
- # _version.py.
- keywords = {}
- try:
- f = open(versionfile_abs, "r")
- for line in f.readlines():
- if line.strip().startswith("git_refnames ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["refnames"] = mo.group(1)
- if line.strip().startswith("git_full ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["full"] = mo.group(1)
- if line.strip().startswith("git_date ="):
- mo = re.search(r'=\s*"(.*)"', line)
- if mo:
- keywords["date"] = mo.group(1)
- f.close()
- except EnvironmentError:
- pass
- return keywords
-
-
-@register_vcs_handler("git", "keywords")
-def git_versions_from_keywords(keywords, tag_prefix, verbose):
- """Get version information from git keywords."""
- if not keywords:
- raise NotThisMethod("no keywords at all, weird")
- date = keywords.get("date")
- if date is not None:
- # Use only the last line. Previous lines may contain GPG signature
- # information.
- date = date.splitlines()[-1]
-
- # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant
- # datestamp. However we prefer "%ci" (which expands to an "ISO-8601
- # -like" string, which we must then edit to make compliant), because
- # it's been around since git-1.5.3, and it's too difficult to
- # discover which version we're using, or to work around using an
- # older one.
- date = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
- refnames = keywords["refnames"].strip()
- if refnames.startswith("$Format"):
- if verbose:
- print("keywords are unexpanded, not using")
- raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
- refs = set([r.strip() for r in refnames.strip("()").split(",")])
- # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
- # just "foo-1.0". If we see a "tag: " prefix, prefer those.
- TAG = "tag: "
- tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
- if not tags:
- # Either we're using git < 1.8.3, or there really are no tags. We use
- # a heuristic: assume all version tags have a digit. The old git %d
- # expansion behaves like git log --decorate=short and strips out the
- # refs/heads/ and refs/tags/ prefixes that would let us distinguish
- # between branches and tags. By ignoring refnames without digits, we
- # filter out many common branch names like "release" and
- # "stabilization", as well as "HEAD" and "master".
- tags = set([r for r in refs if re.search(r'\d', r)])
- if verbose:
- print("discarding '%s', no digits" % ",".join(refs - tags))
- if verbose:
- print("likely tags: %s" % ",".join(sorted(tags)))
- for ref in sorted(tags):
- # sorting will prefer e.g. "2.0" over "2.0rc1"
- if ref.startswith(tag_prefix):
- r = ref[len(tag_prefix):]
- if verbose:
- print("picking %s" % r)
- return {"version": r,
- "full-revisionid": keywords["full"].strip(),
- "dirty": False, "error": None,
- "date": date}
- # no suitable tags, so version is "0+unknown", but full hex is still there
- if verbose:
- print("no suitable tags, using unknown + full revision id")
- return {"version": "0+unknown",
- "full-revisionid": keywords["full"].strip(),
- "dirty": False, "error": "no suitable tags", "date": None}
-
-
-@register_vcs_handler("git", "pieces_from_vcs")
-def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
- """Get version from 'git describe' in the root of the source tree.
-
- This only gets called if the git-archive 'subst' keywords were *not*
- expanded, and _version.py hasn't already been rewritten with a short
- version string, meaning we're inside a checked out source tree.
- """
- GITS = ["git"]
- if sys.platform == "win32":
- GITS = ["git.cmd", "git.exe"]
-
- out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root,
- hide_stderr=True)
- if rc != 0:
- if verbose:
- print("Directory %s not under git control" % root)
- raise NotThisMethod("'git rev-parse --git-dir' returned error")
-
- # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
- # if there isn't one, this yields HEX[-dirty] (no NUM)
- describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty",
- "--always", "--long",
- "--match", "%s*" % tag_prefix],
- cwd=root)
- # --long was added in git-1.5.5
- if describe_out is None:
- raise NotThisMethod("'git describe' failed")
- describe_out = describe_out.strip()
- full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
- if full_out is None:
- raise NotThisMethod("'git rev-parse' failed")
- full_out = full_out.strip()
-
- pieces = {}
- pieces["long"] = full_out
- pieces["short"] = full_out[:7] # maybe improved later
- pieces["error"] = None
-
- # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
- # TAG might have hyphens.
- git_describe = describe_out
-
- # look for -dirty suffix
- dirty = git_describe.endswith("-dirty")
- pieces["dirty"] = dirty
- if dirty:
- git_describe = git_describe[:git_describe.rindex("-dirty")]
-
- # now we have TAG-NUM-gHEX or HEX
-
- if "-" in git_describe:
- # TAG-NUM-gHEX
- mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
- if not mo:
- # unparseable. Maybe git-describe is misbehaving?
- pieces["error"] = ("unable to parse git-describe output: '%s'"
- % describe_out)
- return pieces
-
- # tag
- full_tag = mo.group(1)
- if not full_tag.startswith(tag_prefix):
- if verbose:
- fmt = "tag '%s' doesn't start with prefix '%s'"
- print(fmt % (full_tag, tag_prefix))
- pieces["error"] = ("tag '%s' doesn't start with prefix '%s'"
- % (full_tag, tag_prefix))
- return pieces
- pieces["closest-tag"] = full_tag[len(tag_prefix):]
-
- # distance: number of commits since tag
- pieces["distance"] = int(mo.group(2))
-
- # commit: short hex revision ID
- pieces["short"] = mo.group(3)
-
- else:
- # HEX: no tags
- pieces["closest-tag"] = None
- count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"],
- cwd=root)
- pieces["distance"] = int(count_out) # total number of commits
-
- # commit date: see ISO-8601 comment in git_versions_from_keywords()
- date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"],
- cwd=root)[0].strip()
- # Use only the last line. Previous lines may contain GPG signature
- # information.
- date = date.splitlines()[-1]
- pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1)
-
- return pieces
-
-
-def do_vcs_install(manifest_in, versionfile_source, ipy):
- """Git-specific installation logic for Versioneer.
-
- For Git, this means creating/changing .gitattributes to mark _version.py
- for export-subst keyword substitution.
- """
- GITS = ["git"]
- if sys.platform == "win32":
- GITS = ["git.cmd", "git.exe"]
- files = [manifest_in, versionfile_source]
- if ipy:
- files.append(ipy)
- try:
- me = __file__
- if me.endswith(".pyc") or me.endswith(".pyo"):
- me = os.path.splitext(me)[0] + ".py"
- versioneer_file = os.path.relpath(me)
- except NameError:
- versioneer_file = "versioneer.py"
- files.append(versioneer_file)
- present = False
- try:
- f = open(".gitattributes", "r")
- for line in f.readlines():
- if line.strip().startswith(versionfile_source):
- if "export-subst" in line.strip().split()[1:]:
- present = True
- f.close()
- except EnvironmentError:
- pass
- if not present:
- f = open(".gitattributes", "a+")
- f.write("%s export-subst\n" % versionfile_source)
- f.close()
- files.append(".gitattributes")
- run_command(GITS, ["add", "--"] + files)
-
-
-def versions_from_parentdir(parentdir_prefix, root, verbose):
- """Try to determine the version from the parent directory name.
-
- Source tarballs conventionally unpack into a directory that includes both
- the project name and a version string. We will also support searching up
- two directory levels for an appropriately named parent directory
- """
- rootdirs = []
-
- for i in range(3):
- dirname = os.path.basename(root)
- if dirname.startswith(parentdir_prefix):
- return {"version": dirname[len(parentdir_prefix):],
- "full-revisionid": None,
- "dirty": False, "error": None, "date": None}
- else:
- rootdirs.append(root)
- root = os.path.dirname(root) # up a level
-
- if verbose:
- print("Tried directories %s but none started with prefix %s" %
- (str(rootdirs), parentdir_prefix))
- raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
-
-
-SHORT_VERSION_PY = """
-# This file was generated by 'versioneer.py' (0.19) from
-# revision-control system data, or from the parent directory name of an
-# unpacked source archive. Distribution tarballs contain a pre-generated copy
-# of this file.
-
-import json
-
-version_json = '''
-%s
-''' # END VERSION_JSON
-
-
-def get_versions():
- return json.loads(version_json)
-"""
-
-
-def versions_from_file(filename):
- """Try to determine the version from _version.py if present."""
- try:
- with open(filename) as f:
- contents = f.read()
- except EnvironmentError:
- raise NotThisMethod("unable to read _version.py")
- mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON",
- contents, re.M | re.S)
- if not mo:
- mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON",
- contents, re.M | re.S)
- if not mo:
- raise NotThisMethod("no version_json in _version.py")
- return json.loads(mo.group(1))
-
-
-def write_to_version_file(filename, versions):
- """Write the given version number to the given _version.py file."""
- os.unlink(filename)
- contents = json.dumps(versions, sort_keys=True,
- indent=1, separators=(",", ": "))
- with open(filename, "w") as f:
- f.write(SHORT_VERSION_PY % contents)
-
- print("set %s to '%s'" % (filename, versions["version"]))
-
-
-def plus_or_dot(pieces):
- """Return a + if we don't already have one, else return a ."""
- if "+" in pieces.get("closest-tag", ""):
- return "."
- return "+"
-
-
-def render_pep440(pieces):
- """Build up version string, with post-release "local version identifier".
-
- Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
- get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
-
- Exceptions:
- 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"] or pieces["dirty"]:
- rendered += plus_or_dot(pieces)
- rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
- if pieces["dirty"]:
- rendered += ".dirty"
- else:
- # exception #1
- rendered = "0+untagged.%d.g%s" % (pieces["distance"],
- pieces["short"])
- if pieces["dirty"]:
- rendered += ".dirty"
- return rendered
-
-
-def render_pep440_pre(pieces):
- """TAG[.post0.devDISTANCE] -- No -dirty.
-
- Exceptions:
- 1: no tags. 0.post0.devDISTANCE
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"]:
- rendered += ".post0.dev%d" % pieces["distance"]
- else:
- # exception #1
- rendered = "0.post0.dev%d" % pieces["distance"]
- return rendered
-
-
-def render_pep440_post(pieces):
- """TAG[.postDISTANCE[.dev0]+gHEX] .
-
- The ".dev0" means dirty. Note that .dev0 sorts backwards
- (a dirty tree will appear "older" than the corresponding clean one),
- but you shouldn't be releasing software with -dirty anyways.
-
- Exceptions:
- 1: no tags. 0.postDISTANCE[.dev0]
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"] or pieces["dirty"]:
- rendered += ".post%d" % pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- rendered += plus_or_dot(pieces)
- rendered += "g%s" % pieces["short"]
- else:
- # exception #1
- rendered = "0.post%d" % pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- rendered += "+g%s" % pieces["short"]
- return rendered
-
-
-def render_pep440_old(pieces):
- """TAG[.postDISTANCE[.dev0]] .
-
- The ".dev0" means dirty.
-
- Exceptions:
- 1: no tags. 0.postDISTANCE[.dev0]
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"] or pieces["dirty"]:
- rendered += ".post%d" % pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- else:
- # exception #1
- rendered = "0.post%d" % pieces["distance"]
- if pieces["dirty"]:
- rendered += ".dev0"
- return rendered
-
-
-def render_git_describe(pieces):
- """TAG[-DISTANCE-gHEX][-dirty].
-
- Like 'git describe --tags --dirty --always'.
-
- Exceptions:
- 1: no tags. HEX[-dirty] (note: no 'g' prefix)
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- if pieces["distance"]:
- rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
- else:
- # exception #1
- rendered = pieces["short"]
- if pieces["dirty"]:
- rendered += "-dirty"
- return rendered
-
-
-def render_git_describe_long(pieces):
- """TAG-DISTANCE-gHEX[-dirty].
-
- Like 'git describe --tags --dirty --always -long'.
- The distance/hash is unconditional.
-
- Exceptions:
- 1: no tags. HEX[-dirty] (note: no 'g' prefix)
- """
- if pieces["closest-tag"]:
- rendered = pieces["closest-tag"]
- rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
- else:
- # exception #1
- rendered = pieces["short"]
- if pieces["dirty"]:
- rendered += "-dirty"
- return rendered
-
-
-def render(pieces, style):
- """Render the given version pieces into the requested style."""
- if pieces["error"]:
- return {"version": "unknown",
- "full-revisionid": pieces.get("long"),
- "dirty": None,
- "error": pieces["error"],
- "date": None}
-
- if not style or style == "default":
- style = "pep440" # the default
-
- if style == "pep440":
- rendered = render_pep440(pieces)
- elif style == "pep440-pre":
- rendered = render_pep440_pre(pieces)
- elif style == "pep440-post":
- rendered = render_pep440_post(pieces)
- elif style == "pep440-old":
- rendered = render_pep440_old(pieces)
- elif style == "git-describe":
- rendered = render_git_describe(pieces)
- elif style == "git-describe-long":
- rendered = render_git_describe_long(pieces)
- else:
- raise ValueError("unknown style '%s'" % style)
-
- return {"version": rendered, "full-revisionid": pieces["long"],
- "dirty": pieces["dirty"], "error": None,
- "date": pieces.get("date")}
-
-
-class VersioneerBadRootError(Exception):
- """The project root directory is unknown or missing key files."""
-
-
-def get_versions(verbose=False):
- """Get the project version from whatever source is available.
-
- Returns dict with two keys: 'version' and 'full'.
- """
- if "versioneer" in sys.modules:
- # see the discussion in cmdclass.py:get_cmdclass()
- del sys.modules["versioneer"]
-
- root = get_root()
- cfg = get_config_from_root(root)
-
- assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg"
- handlers = HANDLERS.get(cfg.VCS)
- assert handlers, "unrecognized VCS '%s'" % cfg.VCS
- verbose = verbose or cfg.verbose
- assert cfg.versionfile_source is not None, \
- "please set versioneer.versionfile_source"
- assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix"
-
- versionfile_abs = os.path.join(root, cfg.versionfile_source)
-
- # extract version from first of: _version.py, VCS command (e.g. 'git
- # describe'), parentdir. This is meant to work for developers using a
- # source checkout, for users of a tarball created by 'setup.py sdist',
- # and for users of a tarball/zipball created by 'git archive' or github's
- # download-from-tag feature or the equivalent in other VCSes.
-
- get_keywords_f = handlers.get("get_keywords")
- from_keywords_f = handlers.get("keywords")
- if get_keywords_f and from_keywords_f:
- try:
- keywords = get_keywords_f(versionfile_abs)
- ver = from_keywords_f(keywords, cfg.tag_prefix, verbose)
- if verbose:
- print("got version from expanded keyword %s" % ver)
- return ver
- except NotThisMethod:
- pass
-
- try:
- ver = versions_from_file(versionfile_abs)
- if verbose:
- print("got version from file %s %s" % (versionfile_abs, ver))
- return ver
- except NotThisMethod:
- pass
-
- from_vcs_f = handlers.get("pieces_from_vcs")
- if from_vcs_f:
- try:
- pieces = from_vcs_f(cfg.tag_prefix, root, verbose)
- ver = render(pieces, cfg.style)
- if verbose:
- print("got version from VCS %s" % ver)
- return ver
- except NotThisMethod:
- pass
-
- try:
- if cfg.parentdir_prefix:
- ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose)
- if verbose:
- print("got version from parentdir %s" % ver)
- return ver
- except NotThisMethod:
- pass
-
- if verbose:
- print("unable to compute version")
-
- return {"version": "0+unknown", "full-revisionid": None,
- "dirty": None, "error": "unable to compute version",
- "date": None}
-
-
-def get_version():
- """Get the short version string for this project."""
- return get_versions()["version"]
-
-
-def get_cmdclass(cmdclass=None):
- """Get the custom setuptools/distutils subclasses used by Versioneer.
-
- If the package uses a different cmdclass (e.g. one from numpy), it
- should be provide as an argument.
- """
- if "versioneer" in sys.modules:
- del sys.modules["versioneer"]
- # this fixes the "python setup.py develop" case (also 'install' and
- # 'easy_install .'), in which subdependencies of the main project are
- # built (using setup.py bdist_egg) in the same python process. Assume
- # a main project A and a dependency B, which use different versions
- # of Versioneer. A's setup.py imports A's Versioneer, leaving it in
- # sys.modules by the time B's setup.py is executed, causing B to run
- # with the wrong versioneer. Setuptools wraps the sub-dep builds in a
- # sandbox that restores sys.modules to it's pre-build state, so the
- # parent is protected against the child's "import versioneer". By
- # removing ourselves from sys.modules here, before the child build
- # happens, we protect the child from the parent's versioneer too.
- # Also see https://github.com/python-versioneer/python-versioneer/issues/52
-
- cmds = {} if cmdclass is None else cmdclass.copy()
-
- # we add "version" to both distutils and setuptools
- from distutils.core import Command
-
- class cmd_version(Command):
- description = "report generated version string"
- user_options = []
- boolean_options = []
-
- def initialize_options(self):
- pass
-
- def finalize_options(self):
- pass
-
- def run(self):
- vers = get_versions(verbose=True)
- print("Version: %s" % vers["version"])
- print(" full-revisionid: %s" % vers.get("full-revisionid"))
- print(" dirty: %s" % vers.get("dirty"))
- print(" date: %s" % vers.get("date"))
- if vers["error"]:
- print(" error: %s" % vers["error"])
- cmds["version"] = cmd_version
-
- # we override "build_py" in both distutils and setuptools
- #
- # most invocation pathways end up running build_py:
- # distutils/build -> build_py
- # distutils/install -> distutils/build ->..
- # setuptools/bdist_wheel -> distutils/install ->..
- # setuptools/bdist_egg -> distutils/install_lib -> build_py
- # setuptools/install -> bdist_egg ->..
- # setuptools/develop -> ?
- # pip install:
- # copies source tree to a tempdir before running egg_info/etc
- # if .git isn't copied too, 'git describe' will fail
- # then does setup.py bdist_wheel, or sometimes setup.py install
- # setup.py egg_info -> ?
-
- # we override different "build_py" commands for both environments
- if 'build_py' in cmds:
- _build_py = cmds['build_py']
- elif "setuptools" in sys.modules:
- from setuptools.command.build_py import build_py as _build_py
- else:
- from distutils.command.build_py import build_py as _build_py
-
- class cmd_build_py(_build_py):
- def run(self):
- root = get_root()
- cfg = get_config_from_root(root)
- versions = get_versions()
- _build_py.run(self)
- # now locate _version.py in the new build/ directory and replace
- # it with an updated value
- if cfg.versionfile_build:
- target_versionfile = os.path.join(self.build_lib,
- cfg.versionfile_build)
- print("UPDATING %s" % target_versionfile)
- write_to_version_file(target_versionfile, versions)
- cmds["build_py"] = cmd_build_py
-
- if "setuptools" in sys.modules:
- from setuptools.command.build_ext import build_ext as _build_ext
- else:
- from distutils.command.build_ext import build_ext as _build_ext
-
- class cmd_build_ext(_build_ext):
- def run(self):
- root = get_root()
- cfg = get_config_from_root(root)
- versions = get_versions()
- _build_ext.run(self)
- if self.inplace:
- # build_ext --inplace will only build extensions in
- # build/lib<..> dir with no _version.py to write to.
- # As in place builds will already have a _version.py
- # in the module dir, we do not need to write one.
- return
- # now locate _version.py in the new build/ directory and replace
- # it with an updated value
- target_versionfile = os.path.join(self.build_lib,
- cfg.versionfile_source)
- print("UPDATING %s" % target_versionfile)
- write_to_version_file(target_versionfile, versions)
- cmds["build_ext"] = cmd_build_ext
-
- if "cx_Freeze" in sys.modules: # cx_freeze enabled?
- from cx_Freeze.dist import build_exe as _build_exe
- # nczeczulin reports that py2exe won't like the pep440-style string
- # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g.
- # setup(console=[{
- # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION
- # "product_version": versioneer.get_version(),
- # ...
-
- class cmd_build_exe(_build_exe):
- def run(self):
- root = get_root()
- cfg = get_config_from_root(root)
- versions = get_versions()
- target_versionfile = cfg.versionfile_source
- print("UPDATING %s" % target_versionfile)
- write_to_version_file(target_versionfile, versions)
-
- _build_exe.run(self)
- os.unlink(target_versionfile)
- with open(cfg.versionfile_source, "w") as f:
- LONG = LONG_VERSION_PY[cfg.VCS]
- f.write(LONG %
- {"DOLLAR": "$",
- "STYLE": cfg.style,
- "TAG_PREFIX": cfg.tag_prefix,
- "PARENTDIR_PREFIX": cfg.parentdir_prefix,
- "VERSIONFILE_SOURCE": cfg.versionfile_source,
- })
- cmds["build_exe"] = cmd_build_exe
- del cmds["build_py"]
-
- if 'py2exe' in sys.modules: # py2exe enabled?
- from py2exe.distutils_buildexe import py2exe as _py2exe
-
- class cmd_py2exe(_py2exe):
- def run(self):
- root = get_root()
- cfg = get_config_from_root(root)
- versions = get_versions()
- target_versionfile = cfg.versionfile_source
- print("UPDATING %s" % target_versionfile)
- write_to_version_file(target_versionfile, versions)
-
- _py2exe.run(self)
- os.unlink(target_versionfile)
- with open(cfg.versionfile_source, "w") as f:
- LONG = LONG_VERSION_PY[cfg.VCS]
- f.write(LONG %
- {"DOLLAR": "$",
- "STYLE": cfg.style,
- "TAG_PREFIX": cfg.tag_prefix,
- "PARENTDIR_PREFIX": cfg.parentdir_prefix,
- "VERSIONFILE_SOURCE": cfg.versionfile_source,
- })
- cmds["py2exe"] = cmd_py2exe
-
- # we override different "sdist" commands for both environments
- if 'sdist' in cmds:
- _sdist = cmds['sdist']
- elif "setuptools" in sys.modules:
- from setuptools.command.sdist import sdist as _sdist
- else:
- from distutils.command.sdist import sdist as _sdist
-
- class cmd_sdist(_sdist):
- def run(self):
- versions = get_versions()
- self._versioneer_generated_versions = versions
- # unless we update this, the command will keep using the old
- # version
- self.distribution.metadata.version = versions["version"]
- return _sdist.run(self)
-
- def make_release_tree(self, base_dir, files):
- root = get_root()
- cfg = get_config_from_root(root)
- _sdist.make_release_tree(self, base_dir, files)
- # now locate _version.py in the new base_dir directory
- # (remembering that it may be a hardlink) and replace it with an
- # updated value
- target_versionfile = os.path.join(base_dir, cfg.versionfile_source)
- print("UPDATING %s" % target_versionfile)
- write_to_version_file(target_versionfile,
- self._versioneer_generated_versions)
- cmds["sdist"] = cmd_sdist
-
- return cmds
-
-
-CONFIG_ERROR = """
-setup.cfg is missing the necessary Versioneer configuration. You need
-a section like:
-
- [versioneer]
- VCS = git
- style = pep440
- versionfile_source = src/myproject/_version.py
- versionfile_build = myproject/_version.py
- tag_prefix =
- parentdir_prefix = myproject-
-
-You will also need to edit your setup.py to use the results:
-
- import versioneer
- setup(version=versioneer.get_version(),
- cmdclass=versioneer.get_cmdclass(), ...)
-
-Please read the docstring in ./versioneer.py for configuration instructions,
-edit setup.cfg, and re-run the installer or 'python versioneer.py setup'.
-"""
-
-SAMPLE_CONFIG = """
-# See the docstring in versioneer.py for instructions. Note that you must
-# re-run 'versioneer.py setup' after changing this section, and commit the
-# resulting files.
-
-[versioneer]
-#VCS = git
-#style = pep440
-#versionfile_source =
-#versionfile_build =
-#tag_prefix =
-#parentdir_prefix =
-
-"""
-
-INIT_PY_SNIPPET = """
-from ._version import get_versions
-__version__ = get_versions()['version']
-del get_versions
-"""
-
-
-def do_setup():
- """Do main VCS-independent setup function for installing Versioneer."""
- root = get_root()
- try:
- cfg = get_config_from_root(root)
- except (EnvironmentError, configparser.NoSectionError,
- configparser.NoOptionError) as e:
- if isinstance(e, (EnvironmentError, configparser.NoSectionError)):
- print("Adding sample versioneer config to setup.cfg",
- file=sys.stderr)
- with open(os.path.join(root, "setup.cfg"), "a") as f:
- f.write(SAMPLE_CONFIG)
- print(CONFIG_ERROR, file=sys.stderr)
- return 1
-
- print(" creating %s" % cfg.versionfile_source)
- with open(cfg.versionfile_source, "w") as f:
- LONG = LONG_VERSION_PY[cfg.VCS]
- f.write(LONG % {"DOLLAR": "$",
- "STYLE": cfg.style,
- "TAG_PREFIX": cfg.tag_prefix,
- "PARENTDIR_PREFIX": cfg.parentdir_prefix,
- "VERSIONFILE_SOURCE": cfg.versionfile_source,
- })
-
- ipy = os.path.join(os.path.dirname(cfg.versionfile_source),
- "__init__.py")
- if os.path.exists(ipy):
- try:
- with open(ipy, "r") as f:
- old = f.read()
- except EnvironmentError:
- old = ""
- if INIT_PY_SNIPPET not in old:
- print(" appending to %s" % ipy)
- with open(ipy, "a") as f:
- f.write(INIT_PY_SNIPPET)
- else:
- print(" %s unmodified" % ipy)
- else:
- print(" %s doesn't exist, ok" % ipy)
- ipy = None
-
- # Make sure both the top-level "versioneer.py" and versionfile_source
- # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so
- # they'll be copied into source distributions. Pip won't be able to
- # install the package without this.
- manifest_in = os.path.join(root, "MANIFEST.in")
- simple_includes = set()
- try:
- with open(manifest_in, "r") as f:
- for line in f:
- if line.startswith("include "):
- for include in line.split()[1:]:
- simple_includes.add(include)
- except EnvironmentError:
- pass
- # That doesn't cover everything MANIFEST.in can do
- # (http://docs.python.org/2/distutils/sourcedist.html#commands), so
- # it might give some false negatives. Appending redundant 'include'
- # lines is safe, though.
- if "versioneer.py" not in simple_includes:
- print(" appending 'versioneer.py' to MANIFEST.in")
- with open(manifest_in, "a") as f:
- f.write("include versioneer.py\n")
- else:
- print(" 'versioneer.py' already in MANIFEST.in")
- if cfg.versionfile_source not in simple_includes:
- print(" appending versionfile_source ('%s') to MANIFEST.in" %
- cfg.versionfile_source)
- with open(manifest_in, "a") as f:
- f.write("include %s\n" % cfg.versionfile_source)
- else:
- print(" versionfile_source already in MANIFEST.in")
-
- # Make VCS-specific changes. For git, this means creating/changing
- # .gitattributes to mark _version.py for export-subst keyword
- # substitution.
- do_vcs_install(manifest_in, cfg.versionfile_source, ipy)
- return 0
-
-
-def scan_setup_py():
- """Validate the contents of setup.py against Versioneer's expectations."""
- found = set()
- setters = False
- errors = 0
- with open("setup.py", "r") as f:
- for line in f.readlines():
- if "import versioneer" in line:
- found.add("import")
- if "versioneer.get_cmdclass()" in line:
- found.add("cmdclass")
- if "versioneer.get_version()" in line:
- found.add("get_version")
- if "versioneer.VCS" in line:
- setters = True
- if "versioneer.versionfile_source" in line:
- setters = True
- if len(found) != 3:
- print("")
- print("Your setup.py appears to be missing some important items")
- print("(but I might be wrong). Please make sure it has something")
- print("roughly like the following:")
- print("")
- print(" import versioneer")
- print(" setup( version=versioneer.get_version(),")
- print(" cmdclass=versioneer.get_cmdclass(), ...)")
- print("")
- errors += 1
- if setters:
- print("You should remove lines like 'versioneer.VCS = ' and")
- print("'versioneer.versionfile_source = ' . This configuration")
- print("now lives in setup.cfg, and should be removed from setup.py")
- print("")
- errors += 1
- return errors
-
-
-if __name__ == "__main__":
- cmd = sys.argv[1]
- if cmd == "setup":
- errors = do_setup()
- errors += scan_setup_py()
- if errors:
- sys.exit(1)