acados icon indicating copy to clipboard operation
acados copied to clipboard
verified publisher icon acados

python 3.10 DeprecationWarning invalid escape sequence

Open comicfans opened this issue 1 year ago • 2 comments

I got a lot of warnings about invalid escape sequence on python 3.10:

acados/interfaces/acados_template/acados_template/acados_model.py:79: DeprecationWarning: invalid escape sequence '\d'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:85: DeprecationWarning: invalid escape sequence '\d'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:122: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi_0`; Default: :code:`None`"""
acados/interfaces/acados_template/acados_template/acados_model.py:124: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi_0(r)`,
acados/interfaces/acados_template/acados_template/acados_model.py:127: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi_0(r)`, input for outer function; Default: :code:`None`"""
acados/interfaces/acados_template/acados_template/acados_model.py:141: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi(r)`,
acados/interfaces/acados_template/acados_template/acados_model.py:148: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi_e`; Default: :code:`None`"""
acados/interfaces/acados_template/acados_template/acados_model.py:150: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi_e(r)`,
acados/interfaces/acados_template/acados_template/acados_model.py:153: DeprecationWarning: invalid escape sequence '\p'
  """CasADi expression for the terminal constraint :math:`\phi_e(r)`, input for outer function; Default: :code:`None`"""
acados/interfaces/acados_template/acados_template/acados_model.py:177: DeprecationWarning: invalid escape sequence '\p'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:182: DeprecationWarning: invalid escape sequence '\p'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:187: DeprecationWarning: invalid escape sequence '\p'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:192: DeprecationWarning: invalid escape sequence '\p'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:197: DeprecationWarning: invalid escape sequence '\p'
  """
acados/interfaces/acados_template/acados_template/acados_model.py:202: DeprecationWarning: invalid escape sequence '\p'
  """
acados/interfaces/acados_template/acados_template/acados_dims.py:207: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{\pi}` - dimension of the image of the inner nonlinear function in positive definite constraints.
acados/interfaces/acados_template/acados_template/acados_dims.py:213: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{\pi}^e` - dimension of the image of the inner nonlinear function in positive definite constraints.
acados/interfaces/acados_template/acados_template/acados_dims.py:219: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{\pi}^0` - dimension of the image of the inner nonlinear function in positive definite constraints.
acados/interfaces/acados_template/acados_template/acados_dims.py:225: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{\phi}` - number of convex-over-nonlinear constraints.
acados/interfaces/acados_template/acados_template/acados_dims.py:231: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{\phi}^0` - number of convex-over-nonlinear constraints at initial shooting node 0.
acados/interfaces/acados_template/acados_template/acados_dims.py:237: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{\phi}^e` - number of convex-over-nonlinear constraints at terminal shooting node N.
acados/interfaces/acados_template/acados_template/acados_dims.py:321: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{{s\phi}^0}` - number of soft convex-over-nonlinear constraints at shooting node 0.
acados/interfaces/acados_template/acados_template/acados_dims.py:327: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{{s\phi}}` - number of soft convex-over-nonlinear constraints.
acados/interfaces/acados_template/acados_template/acados_dims.py:333: DeprecationWarning: invalid escape sequence '\p'
  """:math:`n_{{s\phi}^e}` - number of soft convex-over-nonlinear constraints at terminal shooting node N.
acados/interfaces/acados_template/acados_template/acados_ocp_cost.py:34: DeprecationWarning: invalid escape sequence '\D'
  """
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:280: DeprecationWarning: invalid escape sequence '\,'
  """:math:`C` - C matrix in :math:`\\underline{g} \\leq D \, u + C \, x \\leq \\bar{g}`
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:288: DeprecationWarning: invalid escape sequence '\,'
  """:math:`D` - D matrix in :math:`\\underline{g} \\leq D \, u + C \, x \\leq \\bar{g}`
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:389: DeprecationWarning: invalid escape sequence '\p'
  """:math:`\\underline{\phi}` - lower bound for convex-over-nonlinear inequalities
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:397: DeprecationWarning: invalid escape sequence '\p'
  """:math:`\\bar{\phi}` - upper bound for convex-over-nonlinear inequalities
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:406: DeprecationWarning: invalid escape sequence '\p'
  """:math:`\\underline{\phi}^e` - lower bound on convex-over-nonlinear inequalities
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:414: DeprecationWarning: invalid escape sequence '\p'
  """:math:`\\bar{\phi}^e` - upper bound on convex-over-nonlinear inequalities
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:422: DeprecationWarning: invalid escape sequence '\p'
  """:math:`\\underline{\phi}^0` - lower bound on convex-over-nonlinear inequalities
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:430: DeprecationWarning: invalid escape sequence '\p'
  """:math:`\\bar{\phi}^0` - upper bound on convex-over-nonlinear inequalities
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:605: DeprecationWarning: invalid escape sequence '\p'
  """:math:`J_{s, \phi}` - matrix coefficient for soft bounds on convex-over-nonlinear constraints.
acados/interfaces/acados_template/acados_template/acados_ocp_constraints.py:745: DeprecationWarning: invalid escape sequence '\m'
  """:math:`x_0 \\in \mathbb{R}^{n_x}` - initial state --

comicfans avatar Oct 08 '24 13:10 comicfans

I am also running with Python 3.10 and don't get those warnings. Newer Python versions, will indeed have errors with these docstrings. Probably, we need to use r strings for all docstrings that use \, as done here https://github.com/cvxpy/cvxpy/pull/2351

FreyJo avatar Oct 09 '24 09:10 FreyJo

these warnings only show when python 3.10 is built with --with-pydebug

comicfans avatar Oct 09 '24 12:10 comicfans