django-findreplace 0.2__py3-none-any.whl

django_findreplace-0.2.dist-info/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2018-2024, Developer Society Limited
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_findreplace-0.2.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: django-findreplace
+Version: 0.2
+Summary: Django Find Replace
+Maintainer-email: The Developer Society <studio@dev.ngo>
+Project-URL: Homepage, https://github.com/developersociety/django-findreplace
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.2
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+
+# Django Find Replace
+
+A [Django](https://www.djangoproject.com/) management command which will replace all instances of
+a string throughout a database with another - useful for bulk content changes.
+
+## Installation
+
+Using [pip](https://pip.pypa.io/):
+
+```console
+$ pip install django-findreplace
+```
+
+Edit your Django project's settings module, and add the application to ``INSTALLED_APPS``:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "findreplace",
+    # ...
+]
+```
+
+## Usage
+
+To replace all instances of *foo* with *bar*:
+
+```console
+$ ./manage.py findreplace foo bar
+```
+
+To use this command without being asked for confirmation:
+
+```console
+$ ./manage.py findreplace --noinput foo bar
+```

django_findreplace-0.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+findreplace/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+findreplace/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+findreplace/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+findreplace/management/commands/findreplace.py,sha256=x6Gq-I81QU3Kxz6_5wcAL5NgN08KlUCQpkpJO_UMLXc,2452
+django_findreplace-0.2.dist-info/LICENSE,sha256=XGMu9iBBTft-0mgZ4IGTqCVHquL9kzM9W4oG5qGXgug,1508
+django_findreplace-0.2.dist-info/METADATA,sha256=FSAZBcPfSGxW8NQm9CVQsckVcmB5BQsgNpzDgLYXU6w,1578
+django_findreplace-0.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+django_findreplace-0.2.dist-info/top_level.txt,sha256=h6H8p1SOLbsj59tHEvD0MIUxkdRD0hID5vyzZavOv9U,12
+django_findreplace-0.2.dist-info/RECORD,,

django_findreplace-0.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_findreplace-0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+findreplace

findreplace/management/commands/findreplace.py

@@ -0,0 +1,70 @@
+from django.apps import apps
+from django.core.management.base import BaseCommand
+from django.db import models
+
+
+class Command(BaseCommand):
+    def add_arguments(self, parser):
+        parser.add_argument("find")
+        parser.add_argument("replace")
+        parser.add_argument(
+            "--noinput",
+            "--no-input",
+            action="store_false",
+            dest="interactive",
+            default=True,
+            help="Tells Django to NOT prompt the user for input of any kind.",
+        )
+
+    def handle(self, *args, **options):
+        if options["interactive"]:
+            self.stdout.write(
+                '\nReplace ALL instances of "{}" with "{}"?\n\n'.format(
+                    options["find"], options["replace"]
+                )
+            )
+            confirm = input("    Type 'yes' to continue, or 'no' to cancel: ")
+        else:
+            confirm = "yes"
+
+        updated_count = 0
+
+        if confirm == "yes":
+            for field in self.get_fields():
+                updated_count += self.find_replace(
+                    field=field, find=options["find"], replace=options["replace"]
+                )
+        else:
+            self.stdout.write("Find and replace cancelled.")
+
+    def find_replace(self, field, find, replace):
+        updated_count = 0
+        model = field.model
+        filter_kwargs = {f"{field.name}__contains": find}
+
+        # To avoid signals at all costs, we have to:
+        # - Use values_list to avoid pre/post init
+        # - Use update to avoid pre/post save
+        queryset = model._default_manager.filter(**filter_kwargs).values_list("pk", field.name)
+        for pk, field_data in queryset.iterator():
+            update_kwargs = {field.name: field_data.replace(find, replace)}
+            updated_count += model._default_manager.filter(pk=pk).update(**update_kwargs)
+
+        return updated_count
+
+    def get_fields(self):
+        """
+        Return a list of fields from installed apps which can be updated.
+
+        Any registered models with fields which extend from CharField or TextField will be returned
+        as a list of fields.
+        """
+        fields = []
+
+        for app in apps.get_app_configs():
+            for model in app.get_models():
+                for field in model._meta.get_fields():
+                    if isinstance(field, (models.CharField, models.TextField)):
+                        fields.append(field)
+
+        return fields