darknessrdg / django-paranoid-model Goto Github PK

View Code? Open in Web Editor NEW

18.0 2.0 4.0 1.18 MB

Django abstract model with paranoid behavior

Home Page: https://darknessrdg.github.io/django-paranoid-model/

License: MIT License

Python 98.47% HTML 1.21% Shell 0.32%

django python django-models paranoid timestamp orm delete

django-paranoid-model's Introduction

Hi there 👋

As a Software Development Engineer, I specialize in creating robust and efficient backend solutions. With a focus on software architecture design, I have expertise in crafting scalable solutions across various technologies and frameworks.

As a senior professional, I am dedicated to staying updated on industry trends and utilizing my passion for software architecture to contribute effectively to projects.

from github import Developer


class AboutMe(Developer):
    name = "Luan"
    last_name = "Rodrigues"
    position = "Software Development Engineer 3"
    nationality = "Brazilian"
    langauges = ["Portuguese", "English"]

🎓 Computer Science Bachelor Degree.
🌱 I’m currently working with Golang and ecossystem
💌 How to reach me:
- professional email: [email protected]
- personal email: [email protected]
⚡ Fun fact: I'm a windows user.
☁ Checkout my personal website

Hands-on Skills

💪 Programing Languages

🔨 Frameworks

💾 Databases

Tools

⚡ Recent Activity

🎉 Merged PR #2 in DarknessRdg/DarknessRdg
💪 Opened PR #2 in DarknessRdg/DarknessRdg
🎉 Merged PR #1 in DarknessRdg/DarknessRdg
💪 Opened PR #1 in DarknessRdg/DarknessRdg

django-paranoid-model's People

Contributors

Stargazers

Watchers

Forkers

jeromelefeuvre pranjal0819 jpchavat-marcofi azuber

django-paranoid-model's Issues

Paranoid restore not working with multiple database when using is none

I have many databases , but no default. When I have a soft deleted instance and i call method restore() it tries to use default database, instead of database where instace comes from.

instance = MyModel.objects.using('database2').get_deleted()

intance.restore()  # this line brokes beacuse I have no default database. 
# But it should use 'database2', wich is database where instance is saved

But if I pass dabase's name it works just fine:

intance.restore('databse2')

Tracekback

>>> instance.restore()
Traceback (most recent call last):
  File "<console>", line 1, in <module>
  File "...\venv\lib\site-packages\paranoid_model\models.py", line 71, in restore
    for related in self._related_objects(using):
  File "...\venv\lib\site-packages\paranoid_model\models.py", line 88, in _related_objects
    collector.collect([self])
  File "...\venv\lib\site-packages\django\contrib\admin\utils.py", line 181, in collect
    return super().collect(objs, source_attr=source_attr, **kwargs)
  File "...\venv\lib\site-packages\django\db\models\deletion.py", line 244, in collect
    if sub_objs:
  File "...\venv\lib\site-packages\django\db\models\query.py", line 280, in __bool__
    self._fetch_all()
  File "...\venv\lib\site-packages\django\db\models\query.py", line 1261, in _fetch_all
    self._result_cache = list(self._iterable_class(self))
  File "...\venv\lib\site-packages\django\db\models\query.py", line 57, in __iter__
    results = compiler.execute_sql(chunked_fetch=self.chunked_fetch, chunk_size=self.chunk_size)
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 1138, in execute_sql
    sql, params = self.as_sql()
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 490, in as_sql
    extra_select, order_by, group_by = self.pre_sql_setup()
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 51, in pre_sql_setup
    self.setup_query()
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 42, in setup_query
    self.select, self.klass_info, self.annotation_col_map = self.get_select()
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 257, in get_select
    sql, params = self.compile(col)
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 422, in compile
    sql, params = node.as_sql(self, self.connection)
  File "...\venv\lib\site-packages\django\db\models\expressions.py", line 770, in as_sql
    return "%s.%s" % (qn(self.alias), qn(self.target.column)), []
  File "...\venv\lib\site-packages\django\db\models\sql\compiler.py", line 413, in quote_name_unless_alias
    r = self.connection.ops.quote_name(name)
  File "...\venv\lib\site-packages\django\db\backends\dummy\base.py", line 20, in complain
    raise ImproperlyConfigured("settings.DATABASES is improperly configured. "
django.core.exceptions.ImproperlyConfigured: settings.DATABASES is improperly configured. Please supply the ENGINE value. Check settings documentation for more details.

Add a `get_object_or_404` shortcurt to catch Soft deleted exception

Create a get_object_or_404 like function to also catch SoftDeleted exception.

An even better approach would be to inherite from Mode.DoesNotExist exception. This way keep compatibility with any legacy code.

Paranoid not removing deleted when querying on previous queryset

I ran into this problem when quering on a previous queryset.

I was creating a new queryset like this, because i need to use multiple databases.

previou_query = MyParanoid.objects.using('database2')
# once done that, a queryset is created

After get my queryset targeted to a database, i neet to query, but when i do the following, django paranoid also filters deleted instances

query1 = previous_query.filter()
# includes deleted instances

To fixe i needed to explicit pass parameter with_deleted like this:

query1 = previous_query.filter(with_deleted=False)
# excludes deleted instances

query1 = previous_query.filter(with_deleted=True)
# includes deleted instances

Django paranoid doesn't work with multiple databases

AttributeError when dealing with models not Paranoid

I have a model with a ForeignKey relation with a Paranoid model, and i'ts throwing an AttributeError because the model doesn't have a is_soft_deleted attribute.

Traceback (most recent call last):
  ...
    return queryset.filter(with_deleted=False)
  File "...\paranoid_model\queryset.py", line 125, in filter
    if kwargs[key].is_soft_deleted:
AttributeError: 'ModelNotParanoid' object has no attribute 'is_soft_deleted'

Queryset `get_or_create` raises SoftDeleteException

A simple issue, demonstrated better by example:

Simply replacing it with get_or_restore does not solve how I intend to use this method for example:

update_or_create also uses get_or_create, maybe it would be better to override get_or_create and catch the SoftDeleteException ?

deleted_at query is lost when Q() is added in filter

Got a problem when trying to use Q()...

Simple to understand by example ^^ :

In [2]: print(WidgetItem.objects.filter(id=3).query)
SELECT * FROM `nfb_widgets_widgetitem` WHERE (`nfb_widgets_widgetitem`.`id` = 3 AND `nfb_widgets_widgetitem`.`deleted_at` IS NULL) ORDER BY `nfb_widgets_widgetitem`.`order` ASC

In [3]: print(WidgetItem.objects.filter(Q(widget__id=3)).query)
SELECT * FROM `nfb_widgets_widgetitem` ORDER BY `nfb_widgets_widgetitem`.`order` ASC

Thanks!

Delete is deleting models that aren't paranoid

When a paranoid model is delete with hard_delete=False , all related models are also delete, including regular models

for example:

Look at the model bellow. Person is Paranoid, but Clothes is not paranoid.

class Person(paranoid_model.Paranoid):
    name = models.CharField(max_length=255)

class Clothes(models.Model):
    description = models.CharField(max_length=255)
    person = models.ForeignKey(Person, on_delete=models.CASCADE, related_name='my_clothes')

When the following command is performed it will delete related clothe from database

person = Person.objects.create(name='Person name')

Clothes.objects.create(description='T-Shirt', person=person)

person.delete()

When delete person instance, the clothe just created will be deleted from database.