merge upstream (Sourcery refactored) #3

sourcery-ai · 2022-06-24T07:28:06Z

Pull Request #2 refactored by Sourcery.

Since the original Pull Request was opened as a fork in a contributor's
repository, we are unable to create a Pull Request branching from it.

To incorporate these changes, you can either:

Merge this Pull Request instead of the original, or
Ask your contributor to locally incorporate these commits and push them to
the original Pull Request
Incorporate changes via command line
```
git fetch https://github.com/synodriver/sqlmodel pull/2/head
git merge --ff-only FETCH_HEAD
git push
```

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

See our documentation here.

Run Sourcery locally

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

Help us improve this pull request!

sourcery-ai · 2022-06-24T07:28:08Z

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:28:09Z

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)

This removes the following comments ( why? ):

# Fix #315

sourcery-ai · 2022-06-24T07:28:09Z

sqlmodel/main.py

+    if issubclass(field.type_, BaseModel) and field.type_.__custom_root_type__:
+        return get_pydantic_root_model_engine_type(
+            get_sqlachemy_type(field.type_.__fields__["__root__"]), field.type_
+        )


Function get_sqlachemy_type refactored with the following changes:

Merge nested if conditions (merge-nested-ifs)

sourcery-ai · 2022-06-24T07:28:09Z

sqlmodel/main.py

-        kwargs.update(cast(Dict[Any, Any], sa_column_kwargs))
+        kwargs |= cast(Dict[Any, Any], sa_column_kwargs)


Function get_column_from_field refactored with the following changes:

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

sourcery-ai · 2022-06-24T07:28:09Z

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:28:09Z

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? ):

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

sourcery-ai · 2022-06-24T07:28:09Z

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:28:10Z

tests/test_enums.py

-    sql_str = str(dialect).rstrip()
-    if sql_str:
-        print(sql_str + ";")
+    if sql_str := str(dialect).rstrip():
+        print(f"{sql_str};")


Function pg_dump refactored with the following changes:

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

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-06-24T07:28:10Z

tests/test_enums.py

-    if sql_str:
-        print(sql_str + ";")
+    if sql_str := str(dialect).rstrip():
+        print(f"{sql_str};")


Function sqlite_dump refactored with the following changes:

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

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-06-24T07:28:10Z

tests/test_types.py

-    str("Hero"),
-    float(0.5),
-    int(5),
-    datetime(year=2020, month=2, day=2, hour=2, minute=2, second=2, microsecond=2),
+    "Hero",
+    0.5,
+    5,
+    datetime(
+        year=2020, month=2, day=2, hour=2, minute=2, second=2, microsecond=2
+    ),
    date(year=2020, month=2, day=2),
    timedelta(
-        days=2, seconds=2, microseconds=2, milliseconds=2, minutes=2, hours=2, weeks=2
+        days=2,
+        seconds=2,
+        microseconds=2,
+        milliseconds=2,
+        minutes=2,
+        hours=2,
+        weeks=2,


Lines 20-26 refactored with the following changes:

Remove unnecessary casts to int, str, float or bool [×3] (remove-unnecessary-cast)

sourcery-ai · 2022-06-24T07:28:14Z

Sourcery Code Quality Report

❌ Merging this PR will decrease code quality in the affected files by 0.04%.

Quality metrics	Before	After	Change
Complexity	10.94 🙂	10.82 🙂	-0.12 👍
Method Length	69.46 🙂	69.00 🙂	-0.46 👍
Working memory	9.13 🙂	9.18 🙂	0.05 👎
Quality	60.42% 🙂	60.38% 🙂	-0.04% 👎

Other metrics	Before	After	Change
Lines	889	877	-12

Changed files	Quality Before	Quality After	Quality Change
sqlmodel/main.py	55.33% 🙂	55.34% 🙂	0.01% 👍
tests/test_enums.py	80.34% ⭐	79.98% ⭐	-0.36% 👎
tests/test_types.py	77.28% ⭐	77.35% ⭐	0.07% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
sqlmodel/main.py	SQLModelMetaclass.__init__	33 ⛔	222 ⛔	16 ⛔	22.64% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	SQLModelMetaclass.__new__	20 😞	294 ⛔	14 😞	28.90% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	get_column_from_field	15 🙂	231 ⛔	12 😞	38.63% 😞	Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	Field	1 ⭐	132 😞	33 ⛔	48.07% 😞	Try splitting into smaller methods. Extract out complex expressions
sqlmodel/main.py	create_model	12 🙂	112 🙂	13 😞	50.69% 🙂	Extract out complex expressions

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!

'Refactored by Sourcery'

b38e048

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

sourcery-ai bot commented Jun 24, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

merge upstream (Sourcery refactored) #3

merge upstream (Sourcery refactored) #3

Uh oh!

sourcery-ai bot commented Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot Jun 24, 2022

Uh oh!

sourcery-ai bot commented Jun 24, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		kwargs.update(cast(Dict[Any, Any], sa_column_kwargs))
		kwargs \|= cast(Dict[Any, Any], sa_column_kwargs)

		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:

merge upstream (Sourcery refactored) #3

Are you sure you want to change the base?

merge upstream (Sourcery refactored) #3

Uh oh!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant