Use Optional instead of Union best practice

Use Optional instead of Union

This could be simplified by using typing.Optional

Core to the philosophy of Python is it's written to be read. Optional does a better job at communicates to the reader that the value is optional. Given that these are completely equivalent:

def foo_bar() -> Optional[int]:
    # sometimes return int other times None

def foo_bar() -> Union[int, None]:
    # sometimes return int other times None

def foo_bar() -> Optional[int]:
    # sometimes return int other times None

def foo_bar() -> Union[int, None]:
    # sometimes return int other times None

Why not choose the easiest to both read and write (the first one)

If our GitHub code review bot spots this issue in your pull request it gives this advice:

code-review-doctorbotsuggested changes just now

helpers.py

def foo_bar() -> Union[int, None]:

This could be simplified by using typing.Optional

Suggested changes

-	def foo_bar() -> Union[int, None]:
+	def foo_bar() -> Optional[int]:

    # sometimes return int other times None

Update helpers.py

Instantly check if you have this issue for free

Works with tools you use

- Detect typos
- Avoid mistakes
- Prevent bugs
- Improve tests
- Read more
- Avoid bugs
- Best practice
- Improve security
- ORM performance
- Read more
- Review PRs
- One click fix
- Clear advice
- Delta aware
- Read more
- Review PRs
- Fix suggested
- Clear advice
- Delta aware
- Read more

Read about how it works.

Code Review Doctor