Sourcery refactored main branch by sourcery-ai[bot] · Pull Request #1 · synodriver/sqlmodel

sourcery-ai · 2022-06-24T07:27:40Z

Branch main refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the main branch, then run:

git fetch origin sourcery/main
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sourcery-ai · 2022-06-24T07:27:42Z

.github/actions/comment-docs-preview-in-pr/app/main.py

-    use_pr: Optional[PullRequest] = None
-    for pr in repo.get_pulls():
-        if pr.head.sha == event.workflow_run.head_commit.id:
-            use_pr = pr
-            break
+    use_pr: Optional[PullRequest] = next(
+        (
+            pr
+            for pr in repo.get_pulls()
+            if pr.head.sha == event.workflow_run.head_commit.id
+        ),
+        None,
+    )
+


Lines 45-49 refactored with the following changes:

Use the built-in function next instead of a for-loop (use-next)

sourcery-ai · 2022-06-24T07:27:42Z

.github/actions/watch-previews/app/main.py

-        notified = False
-        for pr_comment in pr_comments:
-            if message in pr_comment.body:
-                notified = True
+        notified = any(message in pr_comment.body for pr_comment in pr_comments)
        logging.info(f"Docs preview was notified: {notified}")
        if not notified:
            artifact_name = f"docs-zip-{commit}"
-            use_artifact: Optional[Artifact] = None
-            for artifact in artifacts_response.artifacts:
-                if artifact.name == artifact_name:
-                    use_artifact = artifact
-                    break
+            use_artifact: Optional[Artifact] = next(
+                (
+                    artifact
+                    for artifact in artifacts_response.artifacts
+                    if artifact.name == artifact_name
+                ),
+                None,
+            )
+


Lines 71-82 refactored with the following changes:

Use any() instead of for loop (use-any)

Use the built-in function next instead of a for-loop (use-next)

sourcery-ai · 2022-06-24T07:27:42Z

docs_src/tutorial/fastapi/app_testing/tutorial001/main.py

 ):
-    heroes = session.exec(select(Hero).offset(offset).limit(limit)).all()
-    return heroes
+    return session.exec(select(Hero).offset(offset).limit(limit)).all()


Function read_heroes refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2022-06-24T07:27:42Z

docs_src/tutorial/fastapi/delete/tutorial001.py

    with Session(engine) as session:
-        heroes = session.exec(select(Hero).offset(offset).limit(limit)).all()
-        return heroes
+        return session.exec(select(Hero).offset(offset).limit(limit)).all()


Function read_heroes refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2022-06-24T07:27:43Z

docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py

    with Session(engine) as session:
-        heroes = session.exec(select(Hero).offset(offset).limit(limit)).all()
-        return heroes
+        return session.exec(select(Hero).offset(offset).limit(limit)).all()


Function read_heroes refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2022-06-24T07:27:45Z

docs_src/tutorial/fastapi/update/tutorial001.py

    with Session(engine) as session:
-        heroes = session.exec(select(Hero).offset(offset).limit(limit)).all()
-        return heroes
+        return session.exec(select(Hero).offset(offset).limit(limit)).all()


Function read_heroes refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2022-06-24T07:27:45Z

sqlmodel/main.py

-    relationship_info = RelationshipInfo(
+    return RelationshipInfo(
        back_populates=back_populates,
        link_model=link_model,
        sa_relationship=sa_relationship,
        sa_relationship_args=sa_relationship_args,
        sa_relationship_kwargs=sa_relationship_kwargs,
    )
-    return relationship_info


Function Relationship refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

sourcery-ai · 2022-06-24T07:27:45Z

sqlmodel/main.py

-    def __init__(
-        cls, classname: str, bases: Tuple[type, ...], dict_: Dict[str, Any], **kw: Any
-    ) -> None:
+    def __init__(self, classname: str, bases: Tuple[type, ...], dict_: Dict[str, Any], **kw: Any) -> None:


Function SQLModelMetaclass.__init__ refactored with the following changes:

The first argument to instance methods should be self (instance-method-first-arg-name)

Merge dictionary updates via the union operator (dict-assign-update-to-union)

sourcery-ai · 2022-06-24T07:27:46Z

sqlmodel/main.py

-    foreign_key = getattr(field.field_info, "foreign_key", None)
-    if foreign_key:
+    if foreign_key := getattr(field.field_info, "foreign_key", None):


Function get_column_from_field refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

Merge dictionary updates via the union operator (dict-assign-update-to-union)

sourcery-ai · 2022-06-24T07:27:46Z

sqlmodel/main.py

-            if getattr(self.__config__, "table", False):
-                if is_instrumented(self, name):
-                    set_attribute(self, name, value)
+            if getattr(self.__config__, "table", False) and is_instrumented(
+                self, name
+            ):
+                set_attribute(self, name, value)


Function SQLModel.__setattr__ refactored with the following changes:

Merge nested if conditions (merge-nested-ifs)

sourcery-ai · 2022-06-24T07:27:54Z

Sourcery Code Quality Report

✅ Merging this PR will increase code quality in the affected files by 0.80%.

Quality metrics	Before	After	Change
Complexity	6.66 ⭐	5.72 ⭐	-0.94 👍
Method Length	47.65 ⭐	47.03 ⭐	-0.62 👍
Working memory	9.18 🙂	9.20 🙂	0.02 👎
Quality	68.94% 🙂	69.74% 🙂	0.80% 👍

Other metrics	Before	After	Change
Lines	2101	2064	-37

Changed files	Quality Before	Quality After	Quality Change
.github/actions/comment-docs-preview-in-pr/app/main.py	38.03% 😞	42.69% 😞	4.66% 👍
.github/actions/watch-previews/app/main.py	45.66% 😞	54.18% 🙂	8.52% 👍
docs_src/tutorial/fastapi/app_testing/tutorial001/main.py	81.77% ⭐	81.89% ⭐	0.12% 👍
docs_src/tutorial/fastapi/delete/tutorial001.py	82.43% ⭐	82.51% ⭐	0.08% 👍
docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py	87.34% ⭐	87.61% ⭐	0.27% 👍
docs_src/tutorial/fastapi/multiple_models/tutorial001.py	83.16% ⭐	82.88% ⭐	-0.28% 👎
docs_src/tutorial/fastapi/multiple_models/tutorial002.py	88.50% ⭐	88.36% ⭐	-0.14% 👎
docs_src/tutorial/fastapi/read_one/tutorial001.py	89.03% ⭐	88.93% ⭐	-0.10% 👎
docs_src/tutorial/fastapi/relationships/tutorial001.py	74.66% 🙂	74.66% 🙂	0.00%
docs_src/tutorial/fastapi/response_model/tutorial001.py	92.15% ⭐	92.13% ⭐	-0.02% 👎
docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py	81.77% ⭐	81.89% ⭐	0.12% 👍
docs_src/tutorial/fastapi/simple_hero_api/tutorial001.py	93.07% ⭐	93.41% ⭐	0.34% 👍
docs_src/tutorial/fastapi/teams/tutorial001.py	76.70% ⭐	76.73% ⭐	0.03% 👍
docs_src/tutorial/fastapi/update/tutorial001.py	81.58% ⭐	81.66% ⭐	0.08% 👍
sqlmodel/main.py	56.87% 🙂	56.60% 🙂	-0.27% 👎
sqlmodel/engine/create.py	23.35% ⛔	23.36% ⛔	0.01% 👍
sqlmodel/sql/sqltypes.py	83.15% ⭐	85.33% ⭐	2.18% 👍
tests/conftest.py	78.64% ⭐	84.70% ⭐	6.06% 👍
tests/test_default.py	82.30% ⭐	82.59% ⭐	0.29% 👍
tests/test_tutorial/test_where/test_tutorial003.py	83.39% ⭐	83.82% ⭐	0.43% 👍
tests/test_tutorial/test_where/test_tutorial004.py	82.00% ⭐	82.41% ⭐	0.41% 👍
tests/test_tutorial/test_where/test_tutorial011.py	82.00% ⭐	82.41% ⭐	0.41% 👍

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
sqlmodel/engine/create.py	create_engine	28 😞	443 ⛔	36 ⛔	11.68% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	SQLModelMetaclass.__init__	33 ⛔	213 ⛔	16 ⛔	23.23% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	SQLModelMetaclass.__new__	17 🙂	257 ⛔	14 😞	32.65% 😞	Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	Field	1 ⭐	125 😞	31 ⛔	49.11% 😞	Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	get_column_from_field	11 🙂	186 😞	9 🙂	50.96% 🙂	Try splitting into smaller methods

Legend and Explanation

The emojis denote the absolute quality of the code:

⭐ excellent
🙂 good
😞 poor
⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

sourcery-ai · 2022-06-24T07:27:51Z

sqlmodel/main.py

-        if not getattr(cls.__config__, "table", False):
-            # If not table, normal Pydantic code
-            m: _TSQLModel = cls.__new__(cls)
-        else:
-            # If table, create the new instance normally to make SQLAlchemy create
-            # the _sa_instance_state attribute
-            m = cls()
+        m = cls() if getattr(cls.__config__, "table", False) else cls.__new__(cls)


Function SQLModel.from_orm refactored with the following changes:

Swap if/else branches of if expression to remove negation (swap-if-expression)

Replace if statement with if expression (assign-if-exp)

This removes the following comments ( why? ):

# the _sa_instance_state attribute # If table, create the new instance normally to make SQLAlchemy create # If not table, normal Pydantic code

sourcery-ai · 2022-06-24T07:27:51Z

sqlmodel/main.py

-        if include is None and exclude is None and exclude_unset is False:
+        if include is None and exclude is None and not exclude_unset:


Function SQLModel._calculate_keys refactored with the following changes:

Simplify comparison to boolean (simplify-boolean-comparison)

Replace if statement with if expression (assign-if-exp)

This removes the following comments ( why? ):

# Updated to not return SQLAlchemy attributes # recursion, or traversing the whole database # Original in Pydantic: # | self.__sqlmodel_relationships__.keys() # keys = self.__dict__.keys() # Do not include relationships as that would easily lead to infinite

sourcery-ai · 2022-06-24T07:27:51Z

sqlmodel/main.py

-    def __tablename__(cls) -> str:
-        return cls.__name__.lower()
+    def __tablename__(self) -> str:
+        return self.__name__.lower()


Function SQLModel.__tablename__ refactored with the following changes:

The first argument to instance methods should be self (instance-method-first-arg-name)

sourcery-ai · 2022-06-24T07:27:51Z

sqlmodel/engine/create.py

    if not isinstance(query_cache_size, _DefaultPlaceholder):
        current_kwargs["query_cache_size"] = query_cache_size
-    current_kwargs.update(kwargs)
+    current_kwargs |= kwargs


Function create_engine refactored with the following changes:

Merge dictionary updates via the union operator (dict-assign-update-to-union)

sourcery-ai · 2022-06-24T07:27:52Z

sqlmodel/sql/sqltypes.py

-            if not isinstance(value, uuid.UUID):
-                return f"{uuid.UUID(value).int:x}"
-            else:
-                # hexstring
-                return f"{value.int:x}"
+            return (
+                f"{value.int:x}"
+                if isinstance(value, uuid.UUID)
+                else f"{uuid.UUID(value).int:x}"
+            )


Function GUID.process_bind_param refactored with the following changes:

Swap if/else branches of if expression to remove negation (swap-if-expression)

Replace if statement with if expression (assign-if-exp)

This removes the following comments ( why? ):

# hexstring

sourcery-ai · 2022-06-24T07:27:53Z

tests/test_default.py

    value2 = Default("bar")

-    assert not (value1 == value2)
+    assert value1 != value2


Function test_not_equality refactored with the following changes:

Simplify logical expression using De Morgan identities (de-morgan)

sourcery-ai · 2022-06-24T07:27:53Z

tests/test_default.py

-    value2 = "foo"
-
-    assert not (value1 == value2)
+    assert value1 != "foo"


Function test_not_equality_other refactored with the following changes:

Inline variable that is only used once (inline-variable)

Simplify logical expression using De Morgan identities (de-morgan)

sourcery-ai · 2022-06-24T07:27:53Z

tests/test_tutorial/test_where/test_tutorial003.py

        # Now that this item was checked, remove it from the list
        calls.pop(calls.index(call))
-    assert len(calls) == 0, "The list should only have the expected items"
+    assert not calls, "The list should only have the expected items"


Function test_tutorial refactored with the following changes:

Simplify sequence length comparison (simplify-len-comparison)

sourcery-ai · 2022-06-24T07:27:54Z

tests/test_tutorial/test_where/test_tutorial004.py

        # Now that this item was checked, remove it from the list
        calls.pop(calls.index(call))
-    assert len(calls) == 0, "The list should only have the expected items"
+    assert not calls, "The list should only have the expected items"


Function test_tutorial refactored with the following changes:

Simplify sequence length comparison (simplify-len-comparison)

sourcery-ai · 2022-06-24T07:27:54Z

tests/test_tutorial/test_where/test_tutorial011.py

        # Now that this item was checked, remove it from the list
        calls.pop(calls.index(call))
-    assert len(calls) == 0, "The list should only have the expected items"
+    assert not calls, "The list should only have the expected items"


Function test_tutorial refactored with the following changes:

Simplify sequence length comparison (simplify-len-comparison)

perf: raise exception if no matching sqlalchemy type

'Refactored by Sourcery'

cf8f4e7

sourcery-ai bot requested a review from synodriver June 24, 2022 07:27

sourcery-ai bot commented Jun 24, 2022

View reviewed changes

synodriver pushed a commit that referenced this pull request Jun 24, 2022

Merge pull request #1 from elben10/main

f427db8

perf: raise exception if no matching sqlalchemy type

		if include is None and exclude is None and exclude_unset is False:
		if include is None and exclude is None and not exclude_unset:

Conversation

sourcery-ai bot commented Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Jun 24, 2022

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants