Review of the --clean-all argument.

Indeed, before this patch, if `--clean-all` was use along with
`--database-type mysql` for example, the whois database table
was cleaned which is not a good idea as it force the system
to retest everything. Causing the tests to run for much more
time that "expected".

Contributors:
    * @mitchellkrogza

Author: funilrys

PyFunceble/__init__.py

@@ -94,7 +94,7 @@
 # We set our project name.
 NAME = "PyFunceble"
 # We set out project version.
-VERSION = "2.1.0.dev (Green Galago: Skitterbug)"
+VERSION = "2.2.0.dev (Green Galago: Skitterbug)"
 
 # We set the list of windows "platforms"
 WINDOWS_PLATFORMS = ["windows", "cygwin", "cygwin_nt-10.0"]
@@ -1283,12 +1283,6 @@ def _command_line():  # pragma: no cover pylint: disable=too-many-branches,too-m
                         {"travis_autosave_minutes": ARGS.autosave_minutes}
                     )
 
-                if ARGS.clean:
-                    Clean(None)
-
-                if ARGS.clean_all:
-                    Clean(None, ARGS.clean_all)
-
                 if ARGS.cmd:
                     CONFIGURATION.update({"command": ARGS.cmd})
 
@@ -1345,9 +1339,6 @@ def _command_line():  # pragma: no cover pylint: disable=too-many-branches,too-m
                 if ARGS.debug:
                     CONFIGURATION.update({"debug": Preset().switch("debug")})
 
-                if ARGS.directory_structure:
-                    DirectoryStructure()
-
                 if ARGS.dns:
                     CONFIGURATION.update({"dns_server": ARGS.dns})
 
@@ -1378,9 +1369,6 @@ def _command_line():  # pragma: no cover pylint: disable=too-many-branches,too-m
                         {"active": Preset().switch(HTTP_CODE["active"], True)}
                     )
 
-                if ARGS.iana:
-                    IANA().update()
-
                 if ARGS.idna:
                     CONFIGURATION.update(
                         {"idna_conversion": Preset().switch("idna_conversion")}
@@ -1433,12 +1421,6 @@ def _command_line():  # pragma: no cover pylint: disable=too-many-branches,too-m
                 if ARGS.processes and ARGS.processes >= 2:
                     CONFIGURATION.update({"maximal_processes": ARGS.processes})
 
-                if ARGS.production:
-                    Production()
-
-                if ARGS.public_suffix:
-                    PublicSuffix().update()
-
                 if ARGS.quiet:
                     CONFIGURATION.update({"quiet": Preset().switch("quiet")})
 
@@ -1481,6 +1463,24 @@ def _command_line():  # pragma: no cover pylint: disable=too-many-branches,too-m
                 if not CONFIGURATION["quiet"]:
                     CLICore.colorify_logo(home=True)
 
+                if ARGS.clean:
+                    Clean(None)
+
+                if ARGS.clean_all:
+                    Clean(None, ARGS.clean_all)
+
+                if ARGS.directory_structure:
+                    DirectoryStructure()
+
+                if ARGS.iana:
+                    IANA().update()
+
+                if ARGS.production:
+                    Production()
+
+                if ARGS.public_suffix:
+                    PublicSuffix().update()
+
                 # We compare the versions (upstream and local) and in between.
                 Version().compare()
 

PyFunceble/clean.py

@@ -256,7 +256,9 @@ def almost_everything(self, clean_all=False):
 
                 sqlite_db = SQLite()
 
-                for database_name in sqlite_db.tables.values():
+                for database_name in [
+                    y for x, y in sqlite_db.tables.items() if x != "whois"
+                ]:
                     query = "DELETE FROM {0}".format(database_name)
 
                     sqlite_db.cursor.execute(query)
@@ -266,7 +268,9 @@ def almost_everything(self, clean_all=False):
 
                 mysql_db = MySQL()
 
-                for database_name in mysql_db.tables.values():
+                for database_name in [
+                    y for x, y in mysql_db.tables.items() if x != "whois"
+                ]:
                     query = "DELETE FROM {0}".format(database_name)
 
                     with mysql_db.get_connection() as cursor:

PyFunceble/config.py

@@ -563,7 +563,9 @@ def __init__(self, used=False):
             # We initiate the link to the upstream version file.
             # It is hard coded because we may not have the chance to have the
             # configuration file everytime we need it.
-            upstream_link = "https://raw.githubusercontent.com/funilrys/PyFunceble/dev/version.yaml"  # pylint: disable=line-too-long
+            upstream_link = (
+                "https://raw.githubusercontent.com/funilrys/PyFunceble/dev/version.yaml"
+            )  # pylint: disable=line-too-long
 
             # We update the link according to our current version.
             upstream_link = self.right_url_from_version(upstream_link)

docs/components/databases.rst

@@ -19,6 +19,18 @@ How do we manage them?
 
 They consist of simple JSON files which are read and updated on the fly.
 
+Warnings around Database (self) management
+------------------------------------------
+
+.. warning::
+    If you plan to delete everything and still manage to use PyFunceble in the future, please use the :code:`--clean-all` argument.
+
+    Indeed, it will delete everything which is related to what we generated except things like the whois database file/table
+    which saves (almost) static data which can be reused in the future.
+
+    Actually, deleting for example the whois database file/table will just make your test run for a much longer time if you
+    retest subject that used to be indexed into the whois database file/table.
+
 Databases types
 ===============
 
@@ -28,7 +40,7 @@ we offer multiple database types which are (as per configuration) :code:`json` (
 Why different database types?
 -----------------------------
 
-With the introduction of the multiprocessing logic, it became natural to introduce other database format as it's a nightmare to update a JSON formatted.
+With the introduction of the multiprocessing logic, it became natural to introduce other database format as it's a nightmare to update a JSON formatted file.
 
 Indeed in order to write or use a JSON formatted database, we have to load it and overwrite it completly.
 It's great while working with a single CPU/process but as soon as we get out of that scope it become unmanagable.

docs/usage/from-a-terminal.rst

@@ -67,7 +67,19 @@ As it is sometimes needed to clean our :code:`output/` directory, this argument
     Clean all files under the output directory along with all file generated by PyFunceble.
 
 .. warning::
-    This really deletes everything we generated without any warning.
+    This really deletes almost everything we generated without any warning.
+
+.. note::
+    We don't delete the whois database file/table because they are (almost) static data which
+    are shared accross launches in your environment.
+
+.. warning::
+    If you plan to clean manually do not delete the whois database file or table as it will
+    make your test finish under a much longer time as usual for you.
+
+.. warning::
+    If you don't combine this argument alongside with the :code:`--database-type` argument or its configurable equivalent,
+    this argument will only clean the JSON formatted databases.
 
 :code:`--cmd` "something"
 ^^^^^^^^^^^^^^^^^^^^^^^^^

version.yaml

@@ -1,4 +1,4 @@
-current_version: '2.1.0.dev (Green Galago: Skitterbug)'
+current_version: '2.2.0.dev (Green Galago: Skitterbug)'
 deprecated: [0.0.0, 0.0.1, 0.65.0, 0.67.1, 0.68.0, 0.69.3, 0.69.5, 0.70.4, 0.71.2,
     0.72.7, 0.73.1, 0.74.5, 0.75.1, 0.76.2, 0.77.0, 0.78.0, 0.79.1, 0.80.9, 0.81.8,
     0.82.4, 0.83.2, 0.84.5, 0.85.0, 0.86.0, 0.87.1, 0.88.3, 0.89.3, 0.90.2, 0.91.1,
@@ -13,7 +13,7 @@ deprecated: [0.0.0, 0.0.1, 0.65.0, 0.67.1, 0.68.0, 0.69.3, 0.69.5, 0.70.4, 0.71.
     1.55.2, 1.56.0, 1.57.0, 1.58.0, 1.59.1, 1.60.0, 1.61.0, 1.62.0, 1.63.1, 1.64.1,
     1.65.0, 1.66.1, 1.67.2, 1.68.0, 1.69.0, 1.70.0, 1.71.0, 1.72.3, 1.73.3, 1.74.5,
     1.75.4, 1.77.0, 1.78.0, 1.79.1, 1.81.0, 1.82.5, 1.83.0, 1.84.0, 1.85.0, 1.86.0,
-    1.87.0, 1.88.0, 1.89.0, 1.90.0, 1.91.0, 2.0.0]
+    1.87.0, 1.88.0, 1.89.0, 1.90.0, 1.91.0, 2.0.0, 2.1.0]
 force_update:
     minimal_version: [0.0.0, 0.0.1, 0.82.5, 0.89.2, 0.94.3, 0.121.0, 0.140.0, 1.3.0]
     status: true