What does the slash mean when help() is listing method signatures?

by

It signifies the end of the positional only parameters, parameters you cannot use as keyword parameters. Before Python 3.8, such parameters could only be specified in the C API.

It means the key argument to __contains__ can only be passed in by position (range(5).__contains__(3)), not as a keyword argument (range(5).__contains__(key=3)), something you can do with positional arguments in pure-python functions.

Also see the Argument Clinic documentation:

To mark all parameters as positional-only in Argument Clinic, add a / on a line by itself after the last parameter, indented the same as the parameter lines.

and the (very recent addition to) the Python FAQ:

A slash in the argument list of a function denotes that the parameters prior to it are positional-only. Positional-only parameters are the ones without an externally-usable name. Upon calling a function that accepts positional-only parameters, arguments are mapped to parameters based solely on their position.

The syntax is now part of the Python language specification, as of version 3.8, see PEP 570 – Python Positional-Only Parameters. Before PEP 570, the syntax was already reserved for possible future inclusion in Python, see PEP 457 – Syntax For Positional-Only Parameters.

Positional-only parameters can lead to cleaner and clearer APIs, make pure-Python implementations of otherwise C-only modules more consistent and easier to maintain, and because positional-only parameters require very little processing, they lead to faster Python code.

More Related Contents:

  1. What does the slash mean in help() output?
  2. Searching for IP addresses in a file
  3. Swapping variable places inside if throws an error
  4. What is the best way to remove accents (normalize) in a Python unicode string?
  5. How to install python3 version of package via pip on Ubuntu?
  6. “for line in…” results in UnicodeDecodeError: ‘utf-8’ codec can’t decode byte
  7. How to add a new column to a CSV file?
  8. How to postpone/defer the evaluation of f-strings?
  9. Why does Python assignment not return a value?
  10. What’s the difference between “pip install” and “python -m pip install”?
  11. Regex matching between two strings?
  12. How do Python functions handle the types of parameters that you pass in?
  13. The smtplib.server.sendmail function in python raises UnicodeEncodeError: ‘ascii’ codec can’t encode character
  14. Difference between python3 and python3m executables
  15. Python 3 replacement for deprecated compiler.ast flatten function
  16. “zsh: illegal hardware instruction python” when installing Tensorflow on macbook pro M1 [duplicate]
  17. When import docx in python3.3 I have error ImportError: No module named ‘exceptions’
  18. How to remove or hide x-axis labels from a seaborn / matplotlib plot
  19. Why do I get “List index out of range” when trying to add consecutive numbers in a list using “for i in list”? [duplicate]
  20. Clarification on the Decimal type in Python
  21. Remove NaN ‘Cells’ without dropping the entire ROW (Pandas,Python3)
  22. Reading a file using a relative path in a Python project
  23. How to install pygame? [duplicate]
  24. “TypeError: ‘type’ object is not subscriptable” in a function signature
  25. Is having a concurrent.futures.ThreadPoolExecutor call dangerous in a FastAPI endpoint?
  26. append dictionary to data frame
  27. How to use a variable as function name in Python
  28. How to compute jaccard similarity from a pandas dataframe
  29. Size of a Python list in memory
  30. Which of the 4 ways to call super() in Python 3 to use?

Leave a Comment