Skip to content

Type execute_query query arg as LiteralString #923

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

Merged
merged 1 commit into from
Apr 27, 2023
Merged

Type execute_query query arg as LiteralString #923

Show file tree
Hide file tree
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
11 changes: 9 additions & 2 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,15 @@
See also https://github.com/neo4j/neo4j-python-driver/wiki for more details.

## NEXT RELEASE
- Renamed experimental `neo4j.RoutingControl.READERS` to `READ` and `WRITERS` to `WRITE`.
- Renamed experimental `driver.query_bookmark_manager` to `execute_query_bookmark_manager`.
- Renamed experimental `neo4j.RoutingControl.READERS` to `READ` and `WRITERS` to
`WRITE`.
- Renamed experimental `driver.query_bookmark_manager` to
`execute_query_bookmark_manager`.
- Query argument to experimental `driver.execute_query` not is typed
`LiteralString` instead of `str` to help mitigate accidental Cypher
injections. There are rare use-cases where a computed string is necessary.
Please use `# type: ignore`, or `typing.cast` to suppress the type checking in
those cases.


## Version 5.7
Expand Down
6 changes: 3 additions & 3 deletions src/neo4j/_async/driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ async def close(self) -> None:
@t.overload
async def execute_query(
self,
query_: str,
query_: te.LiteralString,
parameters_: t.Optional[t.Dict[str, t.Any]] = None,
routing_: T_RoutingControl = RoutingControl.WRITE,
database_: t.Optional[str] = None,
Expand All @@ -584,7 +584,7 @@ async def execute_query(
@t.overload
async def execute_query(
self,
query_: str,
query_: te.LiteralString,
parameters_: t.Optional[t.Dict[str, t.Any]] = None,
routing_: T_RoutingControl = RoutingControl.WRITE,
database_: t.Optional[str] = None,
Expand All @@ -602,7 +602,7 @@ async def execute_query(

async def execute_query(
self,
query_: str,
query_: te.LiteralString,
parameters_: t.Optional[t.Dict[str, t.Any]] = None,
routing_: T_RoutingControl = RoutingControl.WRITE,
database_: t.Optional[str] = None,
Expand Down
6 changes: 3 additions & 3 deletions src/neo4j/_sync/driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ def close(self) -> None:
@t.overload
def execute_query(
self,
query_: str,
query_: te.LiteralString,
parameters_: t.Optional[t.Dict[str, t.Any]] = None,
routing_: T_RoutingControl = RoutingControl.WRITE,
database_: t.Optional[str] = None,
Expand All @@ -583,7 +583,7 @@ def execute_query(
@t.overload
def execute_query(
self,
query_: str,
query_: te.LiteralString,
parameters_: t.Optional[t.Dict[str, t.Any]] = None,
routing_: T_RoutingControl = RoutingControl.WRITE,
database_: t.Optional[str] = None,
Expand All @@ -601,7 +601,7 @@ def execute_query(

def execute_query(
self,
query_: str,
query_: te.LiteralString,
parameters_: t.Optional[t.Dict[str, t.Any]] = None,
routing_: T_RoutingControl = RoutingControl.WRITE,
database_: t.Optional[str] = None,
Expand Down