Propose to disable system checks for generateproto, eliminating the need for a database connection.

[nohzafk]

Scenario

I want to generate protobuf using python manage.py generateproto command using a docker image

docker run --rm -v '.:/code' --entrypoint 'python'  <image_name> manage.py generateproto --project "server.settings"

It will attempt to connect to the database, as this is the default behavior of the Django command. An section of error log is attached below.

To my understanding, generating the protobuf files doesn't require actual database connection, add a --skip-checks to the command and it will work

docker run --rm -v '.:/code' --entrypoint 'python'  <image_name> manage.py generateproto --project "server.settings" --skip-checks

Proposal

Maybe we should disable the system checks at the generateproto command like this

class Command(BaseCommand):
    help = "Generates proto."
    # disable system checks and migration checks
    requires_system_checks = []
    requires_migrations_checks = []

Or document the usage of generateproto --skip-checks for skipping database connection

What do you think?

Error log

...
Traceback (most recent call last):
  File "/code/manage.py", line 30, in <module>
    main()
  File "/code/manage.py", line 26, in main
    management.execute_from_command_line(sys.argv)
  File "/usr/local/lib/python3.12/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/usr/local/lib/python3.12/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/usr/local/lib/python3.12/site-packages/django/core/management/base.py", line 412, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/usr/local/lib/python3.12/site-packages/django/core/management/base.py", line 453, in execute
    self.check()
  File "/usr/local/lib/python3.12/site-packages/django/core/management/base.py", line 485, in check
    all_issues = checks.run_checks(
                 ^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/django/core/checks/registry.py", line 88, in run_checks
    new_errors = check(app_configs=app_configs, databases=databases)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 ...

django.db.utils.OperationalError: connection to server at "localhost" (::1), port 5432 failed: Connection refused
        Is the server running on that host and accepting TCP/IP connections?
connection to server at "localhost" (127.0.0.1), port 5432 failed: Connection refused
        Is the server running on that host and accepting TCP/IP connections?

[AMontagu]

Hello @nohzafk

I understand the need. I am afraid that disabling all system check before runing the command may lead other developers to false issue when using generateproto commands (eg: just change some code that make a check crash but want to generate the proto before runing the server)

Also --skip-checks sound perfect for that. I don't see any reason to not use it if needed.

Do you feel to create a PR with this documented ?

[nohzafk]

Yes, I will create a PR to document this usage. This will also be a good opportunity for me to learn how to enhance the documentation.

Where do you think we should put this information?

[AMontagu]

You have the documentation on the DSG commands here: https://github.com/socotecio/django-socio-grpc/blob/master/docs/features/commands.rst

It map to https://django-socio-grpc.readthedocs.io/en/stable/features/commands.html when build