pydo icon indicating copy to clipboard operation
pydo copied to clipboard

Published 20 hours ago • verified publisher icon digitalocean

Auto-generated docstring errors

Open reinvantveer opened this issue 9 months ago • 3 comments

When importing the module in Python 3.12:

/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/_client.py:60: SyntaxWarning: invalid escape sequence '\ '
  """Introduction
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:39592: SyntaxWarning: invalid escape sequence '\ '
  """Update an App.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:46410: SyntaxWarning: invalid escape sequence '\ '
  """Update an App.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:52264: SyntaxWarning: invalid escape sequence '\ '
  """Update an App.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:66265: SyntaxWarning: invalid escape sequence '\ '
  """List Instance Sizes.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:66360: SyntaxWarning: invalid escape sequence '\ '
  """Retrieve an Instance Size.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:77700: SyntaxWarning: invalid escape sequence '\ '
  """Purge the Cache for an Existing CDN Endpoint.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:77754: SyntaxWarning: invalid escape sequence '\ '
  """Purge the Cache for an Existing CDN Endpoint.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:77795: SyntaxWarning: invalid escape sequence '\ '
  """Purge the Cache for an Existing CDN Endpoint.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:78047: SyntaxWarning: invalid escape sequence '\ '
  """Create a New Certificate.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:78108: SyntaxWarning: invalid escape sequence '\ '
  """Create a New Certificate.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:78164: SyntaxWarning: invalid escape sequence '\ '
  """Create a New Certificate.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:83116: SyntaxWarning: invalid escape sequence '\ '
  """List Backups for a Database Cluster.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:83231: SyntaxWarning: invalid escape sequence '\ '
  """List All Read-only Replicas.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:83415: SyntaxWarning: invalid escape sequence '\ '
  """Create a Read-only Replica.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:83591: SyntaxWarning: invalid escape sequence '\ '
  """Create a Read-only Replica.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:83704: SyntaxWarning: invalid escape sequence '\ '
  """Create a Read-only Replica.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:84014: SyntaxWarning: invalid escape sequence '\ '
  """Retrieve an Existing Read-only Replica.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:84189: SyntaxWarning: invalid escape sequence '\ '
  """Destroy a Read-only Replica.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:84294: SyntaxWarning: invalid escape sequence '\ '
  """Promote a Read-only Replica to become a Primary Cluster.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:87895: SyntaxWarning: invalid escape sequence '\ '
  """Upgrade Major Version for a Database.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:87943: SyntaxWarning: invalid escape sequence '\ '
  """Upgrade Major Version for a Database.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:87980: SyntaxWarning: invalid escape sequence '\ '
  """Upgrade Major Version for a Database.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:90486: SyntaxWarning: invalid escape sequence '\ '
  """List All Domain Records.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:93809: SyntaxWarning: invalid escape sequence '\ '
  """List Associated Resources for a Droplet.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:93973: SyntaxWarning: invalid escape sequence '\ '
  """Selectively Destroy a Droplet and its Associated Resources.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:94048: SyntaxWarning: invalid escape sequence '\ '
  """Selectively Destroy a Droplet and its Associated Resources.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:94094: SyntaxWarning: invalid escape sequence '\ '
  """Selectively Destroy a Droplet and its Associated Resources.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:100033: SyntaxWarning: invalid escape sequence '\ '
  """Create Trigger.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:100125: SyntaxWarning: invalid escape sequence '\ '
  """Create Trigger.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:100193: SyntaxWarning: invalid escape sequence '\ '
  """Create Trigger.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:100976: SyntaxWarning: invalid escape sequence '\ '
  """List All Images.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:104945: SyntaxWarning: invalid escape sequence '\ '
  """Selectively Delete a Cluster and its Associated Resources.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:105011: SyntaxWarning: invalid escape sequence '\ '
  """Selectively Delete a Cluster and its Associated Resources.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:105056: SyntaxWarning: invalid escape sequence '\ '
  """Selectively Delete a Cluster and its Associated Resources.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:105280: SyntaxWarning: invalid escape sequence '\ '
  """Retrieve the kubeconfig for a Kubernetes Cluster.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:105397: SyntaxWarning: invalid escape sequence '\ '
  """Retrieve Credentials for a Kubernetes Cluster.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:117495: SyntaxWarning: invalid escape sequence '\ '
  """Create Container Registry.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:117581: SyntaxWarning: invalid escape sequence '\ '
  """Create Container Registry.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:117652: SyntaxWarning: invalid escape sequence '\ '
  """Create Container Registry.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:118865: SyntaxWarning: invalid escape sequence '\ '
  """List All Container Registry Repository Tags.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:119011: SyntaxWarning: invalid escape sequence '\ '
  """Delete Container Registry Repository Tag.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:119129: SyntaxWarning: invalid escape sequence '\ '
  """List All Container Registry Repository Manifests.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:119285: SyntaxWarning: invalid escape sequence '\ '
  """Delete Container Registry Repository Manifest.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:120319: SyntaxWarning: invalid escape sequence '\ '
  """Create a New Reserved IP.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:120405: SyntaxWarning: invalid escape sequence '\ '
  """Create a New Reserved IP.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:120486: SyntaxWarning: invalid escape sequence '\ '
  """Create a New Reserved IP.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:122860: SyntaxWarning: invalid escape sequence '\ '
  """Tag a Resource.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:122918: SyntaxWarning: invalid escape sequence '\ '
  """Tag a Resource.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:122959: SyntaxWarning: invalid escape sequence '\ '
  """Tag a Resource.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:123085: SyntaxWarning: invalid escape sequence '\ '
  """Untag a Resource.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:123143: SyntaxWarning: invalid escape sequence '\ '
  """Untag a Resource.
/home/runner/.cache/pypoetry/virtualenvs/infra-IUSmebnC-py3.12/lib/python3.12/site-packages/pydo/operations/_operations.py:123184: SyntaxWarning: invalid escape sequence '\ '
  """Untag a Resource.

reinvantveer avatar May 14 '24 13:05 reinvantveer

Thanks for bringing this to our attention. Looks like there's a fix for this in autorest, the upstream client generation tool we use for pydo, here. Once this change is merged in from their side, it should resolve the issue on our end.

danaelhe avatar May 14 '24 14:05 danaelhe

I guess there is a misunderstanding here: https://github.com/Azure/autorest.python/pull/2560 is the escape PR for AutoRest Python, and it is included since version 6.13.16. Updating AUTOREST_PYTHON_VERSION in Makefile would simply fix this IMO.

The PR you mentioned is for the repo for generating Azure CLI's own commands, not related to AutoRest.

onlined avatar May 14 '24 20:05 onlined

onlined

Oh 🤦‍♀️ overlooked that...thank you so much. That's very helpful. Used your suggestion and it solved the issue 👍 Thanks again.

danaelhe avatar May 14 '24 21:05 danaelhe