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

feat!: migrate to use microgen #34

Merged
merged 2 commits into from
Aug 18, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,14 @@ branch = True
[report]
fail_under = 100
show_missing = True
omit = google/cloud/dlp/__init__.py
exclude_lines =
# Re-enable the standard pragma
pragma: NO COVER
# Ignore debug-only repr
def __repr__
# Ignore abstract methods
raise NotImplementedError
omit =
*/gapic/*.py
*/proto/*.py
*/core/*.py
*/site-packages/*.py
# Ignore pkg_resources exceptions.
# This is added at the module level as a safeguard for if someone
# generates the code and tries to run it without pip installing. This
# makes it virtually impossible to test properly.
except pkg_resources.DistributionNotFound
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,13 @@ dependencies.

Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Python >= 3.5
Python >= 3.6

Deprecated Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^
Python == 2.7. Python 2.7 support will be removed on January 1, 2020.
Python == 2.7.

The last version of this library compatible with Python 2.7 is google-cloud-dlp==1.1.0.


Mac/Linux
Expand Down
161 changes: 161 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# 2.0.0 Migration Guide

The 2.0 release of the `google-cloud-dlp` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.

If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-dlp/issues).

## Supported Python Versions

> **WARNING**: Breaking change

The 2.0.0 release requires Python 3.6+.


## Method Calls

> **WARNING**: Breaking change

Methods expect request objects. We provide a script that will convert most common use cases.

* Install the library

```py
python3 -m pip install google-cloud-dlp
```

* The script `fixup_dlp_v2_keywords.py` is shipped with the library. It expects
an input directory (with the code to convert) and an empty destination directory.

```sh
$ fixup_dlp_v2_keywords.py --input-directory .samples/ --output-directory samples/
```

**Before:**
```py
from google.cloud import dlp

client = dlp.DlpServiceClient()

template = client.get_inspect_template(name="name")
```


**After:**
```py
from google.cloud import dlp

client = dlp.DlpServiceClient()

template = client.get_inspect_template(request={"name": "name"})
```

### More Details

In `google-cloud-dlp<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.

**Before:**
```py
def create_inspect_template(
self,
parent,
inspect_template,
template_id=None,
location_id=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
```

In 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:**
```py
def create_inspect_template(
self,
request: dlp.CreateInspectTemplateRequest = None,
*,
parent: str = None,
inspect_template: dlp.InspectTemplate = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> dlp.InspectTemplate:
```

> **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:

```py
response = client.create_inspect_template(
request={
"parent": parent,
"inspect_template": inspect_template,
}
)
```

```py
response = client.create_inspect_template(
parent=parent,
inspect_template=inspect_template,
)
```

This call is invalid because it mixes `request` with a keyword argument `inspect_template`. Executing this code will result in an error.

```py
response = client.list_builds(
request={
"parent": parent,
},
inspect_template=inspect_template
)
```



## Enums and Types


> **WARNING**: Breaking change

The submodules `enums` and `types` have been removed.

**Before:**
```py
from google.cloud import dlp

file_type = dlp.enums.FileType.IMAGE
finding = dlp.types.Finding(name="name")
```


**After:**
```py
from google.cloud import dlp

file_type = dlp.FileType.IMAGE
finding = dlp.Finding(name="name")
```

## Path Helper Methods

The following path helper methods have been removed. Please construct
these paths manually.

```py
project = 'my-project'
dlp_job = 'dlp-job'
location = 'location'

project_path = f'projects/{project}'
dlp_job_path = f'projects/{project}/dlpJobs/{dlp_job}'
location_path = f'projects/{project}/locations/{location}'
```
1 change: 1 addition & 0 deletions docs/UPGRADING.md
6 changes: 6 additions & 0 deletions docs/dlp_v2/services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Services for Google Cloud Dlp v2 API
====================================

.. automodule:: google.cloud.dlp_v2.services.dlp_service
:members:
:inherited-members:
5 changes: 5 additions & 0 deletions docs/dlp_v2/types.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Types for Google Cloud Dlp v2 API
=================================

.. automodule:: google.cloud.dlp_v2.types
:members:
6 changes: 0 additions & 6 deletions docs/gapic/v2/api.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/gapic/v2/types.rst

This file was deleted.

14 changes: 12 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,20 @@ Api Reference
.. toctree::
:maxdepth: 2

gapic/v2/api
gapic/v2/types
dlp_v2/services
dlp_v2/types
changelog

Migration Guide
---------------

See the guide below for instructions on migrating to the 2.x release of this library.

.. toctree::
:maxdepth: 2

UPGRADING

Changelog
---------

Expand Down
25 changes: 0 additions & 25 deletions google/cloud/dlp.py

This file was deleted.

Loading