[BEAM-1345] Clearly delineate public api in apache_beam/coders. #3090
Conversation
|
can we remove the coders import from the root apache_beam/init.py then? |
| """For internal use only; no backwards-compatibility guarantees. | ||
|
|
||
| Returns the CoderImpl backing this Coder. | ||
| """ |
There was a problem hiding this comment.
Can you please also mark as_cloud_object(), get_estimated_size_and_observables() and the *_runner_api() functions in this way?
| """For internal use only; no backwards-compatibility guarantees. | ||
|
|
||
| Returns the CoderImpl backing this Coder. | ||
| """ | ||
| if not hasattr(self, '_impl'): |
There was a problem hiding this comment.
Can you also mark LengthPrefixCoder as internal / experimental?
| @@ -21,7 +21,7 @@ | |||
| from __future__ import absolute_import | |||
| import logging | |||
|
|
|||
| from apache_beam import coders | |||
| from apache_beam.coders import coders | |||
There was a problem hiding this comment.
What is the guidance now for usage of the Coder class? Are users expected to do something like this?
class MyCoder(beam.coders.coders.Coder):
...Did you also mean to change coders/__init__.py, or is the simpler form (beam.coders.Coder) still permitted / recommended in user code? (CC: @sb2nov)
There was a problem hiding this comment.
coders/__init__.py changed because of the __all__ in coders/coders.py
This is only needed because it uses the no-public ToString Coder. beam.coders.Coder is still recommended.
|
Removing coders from |
|
PTAL |
| @@ -21,7 +21,7 @@ | |||
| from __future__ import absolute_import | |||
| import logging | |||
|
|
|||
| from apache_beam import coders | |||
| from apache_beam.coders import coders | |||
|
Will merge as soon as tests finish (green). |
|
@aaltay for cherry-pick |
Be sure to do all of the following to help us incorporate your contribution
quickly and easily:
[BEAM-<Jira issue #>] Description of pull requestmvn clean verify.<Jira issue #>in the title with the actual Jira issuenumber, if there is one.
Individual Contributor License Agreement.