PyDocs

Nav

Development Tools

LiteralString

typing

data · Added in 3.11
Represents an arbitrary literal string.

Example::

    from typing import LiteralString

    def run_query(sql: LiteralString) -> None:
        ...

    def caller(arbitrary_string: str, literal_string: LiteralString) -> None:
        run_query("SELECT * FROM students")  # OK
        run_query(literal_string)  # OK
        run_query("SELECT * FROM " + literal_string)  # OK
        run_query(arbitrary_string)  # type checker error
        run_query(  # type checker error
            f"SELECT * FROM students WHERE name = {arbitrary_string}"
        )

Only string literals and other LiteralStrings are compatible
with LiteralString. This provides a tool to help prevent
security issues such as SQL injection.
0 Examples
No examples for typing/LiteralString.
See Also
No see-alsos for typing/LiteralString
0 Notes
No notes for LiteralString