Skip to content

Fix warnings when running _roofit.pyzdoc #21902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
couet wants to merge 1 commit into
base: master
Choose a base branch
from
+33 −33
Open

Fix warnings when running _roofit.pyzdoc #21902

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 33 additions & 33 deletions documentation/doxygen/print_roofit_pyz_doctrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

# If the signature doesn't include the function parameters or they are
# empty, we are done.
if not "(" in sig or "()" in sig:

Check failure on line 26 in documentation/doxygen/print_roofit_pyz_doctrings.py

View workflow job for this annotation

GitHub Actions / ruff

ruff (E713) 

documentation/doxygen/print_roofit_pyz_doctrings.py:26:12: E713 Test for membership should be `not in`
  help: Convert to `not in`
return sig

def strip_defaults_from_param_sig(param_sig):
Expand All @@ -34,8 +34,8 @@
split_was_at_equal_sign.append(True)
elif c == ",":
split_was_at_equal_sign.append(False)
l = param_sig.replace("=", ",").split(",")

Check failure on line 37 in documentation/doxygen/print_roofit_pyz_doctrings.py

View workflow job for this annotation

GitHub Actions / ruff

ruff (E741) 

documentation/doxygen/print_roofit_pyz_doctrings.py:37:9: E741 Ambiguous variable name: `l`
l = [l for l, was in zip(l, split_was_at_equal_sign) if not was]

Check failure on line 38 in documentation/doxygen/print_roofit_pyz_doctrings.py

View workflow job for this annotation

GitHub Actions / ruff

ruff (E741) 

documentation/doxygen/print_roofit_pyz_doctrings.py:38:20: E741 Ambiguous variable name: `l`

Check failure on line 38 in documentation/doxygen/print_roofit_pyz_doctrings.py

View workflow job for this annotation

GitHub Actions / ruff

ruff (E741) 

documentation/doxygen/print_roofit_pyz_doctrings.py:38:9: E741 Ambiguous variable name: `l`
return ",".join(l)

def strip_defaults(sig):
Expand Down Expand Up @@ -74,19 +74,19 @@
if klass.__doc__ is None:
return

print("\class " + klass.__cpp_name__)
print("\\brief \parblock \endparblock")
print("\htmlonly")
print('<div class="pyrootbox">')
print("\endhtmlonly")
print("## PyROOT")
print(r"\class " + klass.__cpp_name__)
print(r"\brief \parblock \endparblock")
print(r"\htmlonly")
print(r'<div class="pyrootbox">')
print(r"\endhtmlonly")
print(r"## PyROOT")

print(inspect.cleandoc(klass.__doc__))

print("\htmlonly")
print("</div>")
print("\endhtmlonly")
print("")
print(r"\htmlonly")
print(r"</div>")
print(r"\endhtmlonly")
print(r"")


def write_pyroot_block_for_function(func):
Expand All @@ -99,19 +99,19 @@
sigs = [sigs]

for sig in sigs:
print("\\fn " + clean_cpp_signature(sig))
print("\\brief \parblock \endparblock")
print("\htmlonly")
print('<div class="pyrootbox">')
print("\endhtmlonly")
print("## PyROOT")
print(r"\fn " + clean_cpp_signature(sig))
print(r"\brief \parblock \endparblock")
print(r"\htmlonly")
print(r'<div class="pyrootbox">')
print(r"\endhtmlonly")
print(r"## PyROOT")

print(inspect.cleandoc(func.__doc__))

print("\htmlonly")
print("</div>")
print("\endhtmlonly")
print("")
print(r"\htmlonly")
print(r"</div>")
print(r"\endhtmlonly")
print(r"")


def print_roofit_pythonization_page():
Expand All @@ -121,13 +121,13 @@
def member_funcs_have_doc(python_class):
funcs_have_doc = False
for func_name in _roofit.get_defined_attributes(python_klass):
if not getattr(python_class, func_name).__doc__ is None:

Check failure on line 124 in documentation/doxygen/print_roofit_pyz_doctrings.py

View workflow job for this annotation

GitHub Actions / ruff

ruff (E714) 

documentation/doxygen/print_roofit_pyz_doctrings.py:124:20: E714 Test for object identity should be `is not`
  help: Convert to `is not`
funcs_have_doc = True
return funcs_have_doc

# Fill separate RooFit pythonization page, starting with the introduction and table of contents...
print("\defgroup RoofitPythonizations RooFit Pythonizations")
print("\ingroup Roofitmain")
print(r"\defgroup RoofitPythonizations RooFit Pythonizations")
print(r"\ingroup Roofitmain")
for python_klass in _roofit.python_classes:
if python_klass.__doc__ is None and not member_funcs_have_doc(python_klass):
continue
Expand All @@ -148,10 +148,10 @@
if python_klass.__doc__ is None and not member_funcs_have_doc(python_klass):
continue

print("\\anchor _" + python_klass.__name__.lower())
print("## " + python_klass.__name__)
print("\see " + python_klass.__name__)
print(r"\anchor _" + python_klass.__name__.lower())
print(r"## " + python_klass.__name__)
print(r"\see " + python_klass.__name__)
if not python_klass.__doc__ is None:

Check failure on line 154 in documentation/doxygen/print_roofit_pyz_doctrings.py

View workflow job for this annotation

GitHub Actions / ruff

ruff (E714) 

documentation/doxygen/print_roofit_pyz_doctrings.py:154:16: E714 Test for object identity should be `is not`
  help: Convert to `is not`
print("")
print(inspect.cleandoc(python_klass.__doc__))
print("")
Expand All @@ -160,17 +160,17 @@
func = getattr(python_klass, func_name)
if func.__doc__ is None:
continue
print("\\anchor _" + (python_klass.__name__ + "_" + func.__name__).lower())
print("### " + python_klass.__name__ + "." + func.__name__)
print(r"\anchor _" + (python_klass.__name__ + "_" + func.__name__).lower())
print(r"### " + python_klass.__name__ + "." + func.__name__)
print(inspect.cleandoc(func.__doc__))
print("")
print(r"")
if hasattr(func, "_cpp_signature"):
sigs = func._cpp_signature
if isinstance(sigs, str):
sigs = [sigs]
for sig in sigs:
print("\see " + clean_cpp_signature(sig))
print("")
print(r"\see " + clean_cpp_signature(sig))
print(r"")


def print_pyroot_blocks_for_cpp_docs():
Expand All @@ -194,11 +194,11 @@
if __name__ == "__main__":

try:
print("/**")
print(r"/**")
print_roofit_pythonization_page()
print("")
print(r"")
print_pyroot_blocks_for_cpp_docs()
print("*/")
print(r"*/")
except ImportError:
# roofit was probably not built
pass
Loading