refactor: hide name attribute from UnevaluatedExpr (#138)

src/ampform/dynamics/__init__.py

@@ -186,7 +186,7 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  s, m_a, _ = self.args
  s = printer._print(s)
  subscript = _indices_to_subscript(_determine_indices(m_a))
- name = R"\rho" + subscript if self.name is None else self.name
+ name = R"\rho" + subscript if self._name is None else self._name
  return fR"{name}\left({s}\right)"
 
 
@@ -221,7 +221,7 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  s, m_a, _ = self.args
  s = printer._print(s)
  subscript = _indices_to_subscript(_determine_indices(m_a))
- name = R"\hat{\rho}" + subscript if self.name is None else self.name
+ name = R"\hat{\rho}" + subscript if self._name is None else self._name
  return fR"{name}\left({s}\right)"
 
 
@@ -254,7 +254,9 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  s = printer._print(s)
  subscript = _indices_to_subscript(_determine_indices(m_a))
  name = (
- R"\rho^\mathrm{ac}" + subscript if self.name is None else self.name
+ R"\rho^\mathrm{ac}" + subscript
+ if self._name is None
+ else self._name
  )
  return fR"{name}\left({s}\right)"
 
@@ -285,7 +287,9 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  s = printer._print(s)
  subscript = _indices_to_subscript(_determine_indices(m_a))
  name = (
- R"\rho^\mathrm{c}" + subscript if self.name is None else self.name
+ R"\rho^\mathrm{c}" + subscript
+ if self._name is None
+ else self._name
  )
  return fR"{name}\left({s}\right)"
 
@@ -357,7 +361,7 @@ def __new__( # pylint: disable=too-many-arguments
  expr._assumptions = cls.default_assumptions
  expr._mhash = None
  expr._args = args
- expr.name = None
+ expr._name = None
  expr.phsp_factor = PhaseSpaceFactor
  if evaluate:
  return expr.evaluate()
@@ -366,7 +370,7 @@ def __new__( # pylint: disable=too-many-arguments
  def __getnewargs__(self) -> tuple:
  # Pickling support, see
  # https://github.com/sympy/sympy/blob/1.8/sympy/core/basic.py#L124-L126
- return (*self.args, self.name, self.phsp_factor)
+ return (*self.args, self._name, self.phsp_factor)
 
  def evaluate(self) -> sp.Expr:
  s, mass0, gamma0, m_a, m_b, angular_momentum, meson_radius = self.args
@@ -386,7 +390,7 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  s, _, width, *_ = self.args
  s = printer._print(s)
  subscript = _indices_to_subscript(_determine_indices(width))
- name = fR"\Gamma{subscript}" if self.name is None else self.name
+ name = fR"\Gamma{subscript}" if self._name is None else self._name
  return fR"{name}\left({s}\right)"
 
 
@@ -425,7 +429,7 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  s, m_a, _ = self.args
  s = printer._print(s)
  subscript = _indices_to_subscript(_determine_indices(m_a))
- name = "q^2" + subscript if self.name is None else self.name
+ name = "q^2" + subscript if self._name is None else self._name
  return fR"{name}\left({s}\right)"
 
 

src/ampform/sympy.py

@@ -19,8 +19,9 @@ class UnevaluatedExpression(sp.Expr):
  """
 
  # https://github.com/sympy/sympy/blob/1.8/sympy/core/basic.py#L74-L77
- __slots__: Tuple[str] = ("name",)
- name: Optional[str]
+ __slots__: Tuple[str] = ("_name",)
+ _name: Optional[str]
+ """Optional instance attribute that can be used in LaTeX representations."""
 
  def __new__( # pylint: disable=unused-argument
  cls, *args: Any, name: Optional[str] = None, **hints: Any
@@ -30,13 +31,13 @@ def __new__( # pylint: disable=unused-argument
  obj._args = args
  obj._assumptions = cls.default_assumptions
  obj._mhash = None
- obj.name = name
+ obj._name = name
  return obj
 
  def __getnewargs__(self) -> tuple:
  # Pickling support, see
  # https://github.com/sympy/sympy/blob/1.8/sympy/core/basic.py#L124-L126
- return (*self.args, self.name)
+ return (*self.args, self._name)
 
  @abstractmethod
  def evaluate(self) -> sp.Expr:
@@ -47,8 +48,8 @@ def _latex(self, printer: LatexPrinter, *args: Any) -> str:
  """Provide a mathematical Latex representation for notebooks."""
  args = tuple(map(printer._print, self.args))
  name = self.__class__.__name__
- if self.name is not None:
- name = self.name
+ if self._name is not None:
+ name = self._name
  return f"{name}{args}"