Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Commit

Permalink
docs: convert UPGRADING guide to RST to fix table formatting (#268)
Browse files Browse the repository at this point in the history
* docs: convert UPGRADING guide to RST to fix table formatting

* use latest post processor image

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people authored Dec 1, 2021
1 parent 634fed7 commit 571171e
Show file tree
Hide file tree
Showing 6 changed files with 204 additions and 179 deletions.
2 changes: 1 addition & 1 deletion .github/.OwlBot.lock.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
docker:
image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
digest: sha256:0e18b9475fbeb12d9ad4302283171edebb6baf2dfca1bd215ee3b34ed79d95d7
digest: sha256:74124fe59b8859f30143dcdea7b78300046d97de816dc53c0e381308a5f4f8bc
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@

### ⚠ BREAKING CHANGES

* This release has breaking changes. See the [2.0.0 Migration Guide](https://github.com/googleapis/python-datacatalog/blob/main/UPGRADING.md) for details.
* This release has breaking changes. See the [2.0.0 Migration Guide](https://github.com/googleapis/python-datacatalog/blob/main/UPGRADING.rst) for details.

### Features

Expand Down
176 changes: 0 additions & 176 deletions UPGRADING.md

This file was deleted.

201 changes: 201 additions & 0 deletions UPGRADING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
3.0.0 Migration Guide
=====================

This document describes the breaking changes that have been made, and what you need to do to update your usage.

The most significant change was introduced at v2.0 release based on a `next-gen code generator <https://github.com/googleapis/gapic-generator-python>`_, and includes substantial interface changes. Existing code written for eariler versions of this library will likely require updates to use this version.

If you experience issues or have questions, please file an `issue <https://github.com/googleapis/python-datacatalog/issues>`_.

Supported Python Versions
-------------------------

+------------------------------+
| Applicable previous versions |
+==============================+
| v1.0.0 or lower |
+------------------------------+

.. warning:
**Breaking change:**
The 2.0.0 release requires Python 3.6+.
Method Calls
------------

+------------------------------+
| Applicable previous versions |
+==============================+
| v1.0.0 or lower |
+------------------------------+

.. warning:
**Breaking change:**
Methods expect request objects. We provide a script that will convert most common use cases.
* Install the library

.. code-block:: shell
python3 -m pip install google-cloud-datacatalog
* The script `fixup_datacatalog_v1_keywords.py` is shipped with the library. It expects
an input directory (with the code to convert) and an empty destination directory.

.. code-block:: shell
fixup_datacatalog_v1_keywords.py --input-directory .samples/ --output-directory samples/
**Before:**

.. code-block:: python
from google.cloud import datacatalog_v1
datacatalog = datacatalog_v1.DataCatalogClient()
return datacatalog.lookup_entry(linked_resource=resource_name)
**After:**

.. code-block:: python
from google.cloud import datacatalog_v1
datacatalog = datacatalog_v1.DataCatalogClient()
return datacatalog.lookup_entry(request={'linked_resource': resource_name})
More Details
^^^^^^^^^^^^

In `google-cloud-datacatalog<=1.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.

**Before:**

.. code-block:: python
def create_entry_group(
self,
parent,
entry_group_id,
entry_group=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
Since the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.

Some methods have additional keyword only parameters. The available parameters depend on the `google.api.method_signature` annotation specified by the API producer.


**After:**

.. code-block:: python
def create_entry_group(
self,
request: datacatalog.CreateEntryGroupRequest = None,
*,
parent: str = None,
entry_group_id: str = None,
entry_group: datacatalog.EntryGroup = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> datacatalog.EntryGroup:
.. note::

The `request` parameter and flattened keyword parameters for the API are mutually exclusive.
Passing both will result in an error.

Both of these calls are valid:

.. code-block:: python
response = client.create_entry_group(
request={
"parent": parent,
"entry_group_id": entry_group_id,
"entry_group": entry_group
}
)
.. code-block:: python
response = client.create_entry_group(
parent=parent,
entry_group_id=entry_group_id,
entry_group=entry_group
) # Make an API request.
This call is invalid because it mixes `request` with a keyword argument `entry_group`. Executing this code
will result in an error.

.. code-block:: python
response = client.create_entry_group(
request={
"parent": parent,
"entry_group_id"=entry_group_id
},
entry_group=entry_group
)
Enums and Types
---------------

+------------------------------+
| Applicable previous versions |
+==============================+
| v2.0.0 or lower |
+------------------------------+

.. warning:
**Breaking changes:**
The submodules `enums` and `types` have been removed; the `type` attributes were renamed to `type_` to avoid name collisions.
**Before:**

.. code-block:: python
from google.cloud import datacatalog_v1
entry = datacatalog_v1.types.Entry()
entry.type = datacatalog_v1.enums.EntryType.FILESET
**After:**

.. code-block:: python
from google.cloud import datacatalog_v1
entry = datacatalog_v1.Entry()
entry.type_ = datacatalog_v1.EntryType.FILESET
The renamed attributes are:

* `TagTemplateField.type` -> `TagTemplatedField.type_`
* `ColumnSchema.type` -> `ColumnSchema.type_`
* `Entry.type` -> `Entry.type_`

Common Resource Path Helper Methods
-----------------------------------

+------------------------------+
| Applicable previous versions |
+==============================+
| v1.0.0 or lower |
+------------------------------+

The `location_path` method existing in `google-cloud-datacatalog<=1.0.0` was renamed to `common_location_path` in v3.0.0.

If you are upgrading from v1.0.0 or lower, modify your code to use new method name.

If you are upgrading from v2.0.0, and constructing paths manually as described in `previous upgrade guide <https://github.com/googleapis/python-datacatalog/blob/v2.0.0/UPGRADING.md#project-path-helper-methods>`_, now you can use `common_location_path` method.

There are also more resource path helper methods were added: `common_billing_account_path`, `common_folder_path`, `common_organization_path`, and `common_project_path`.
1 change: 0 additions & 1 deletion docs/UPGRADING.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/UPGRADING.rst

0 comments on commit 571171e

Please sign in to comment.