You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/09/24 22:48:21 UTC

[jira] [Commented] (BEAM-528) Add @experimental annotations

    [ https://issues.apache.org/jira/browse/BEAM-528?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15519756#comment-15519756 ] 

ASF GitHub Bot commented on BEAM-528:
-------------------------------------

GitHub user mariapython opened a pull request:

    https://github.com/apache/incubator-beam/pull/999

    [BEAM-528] Add warning to deprecated / experimental API

    Provide users a warning when they call a deprecated or experimental API. 
    TODO (@mariagh):
    - [x] Implement a decorator to deprecated APIs. The decorator takes a 'since' parameter to inform of when the API was deprecated and can also take a 'current' parameter with a suggested API replacement.
    - [x] Implement a decorator to experimental APIs. The decorator can take a 'current' parameter with a suggested API replacement.
    - [x] Implement unit tests for the different parameter options and to limit the warning to just one per call.
    - [ ] Discuss the necessity of decorating deprecated/experimental classes.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mariapython/incubator-beam python-sdk

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-beam/pull/999.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #999
    
----
commit 1f66cbf08cf18047ce67ea4eaa95dcea6872a532
Author: Thomas Groh <tg...@google.com>
Date:   2016-05-18T23:56:06Z

    Update the Default Pipeline Runner
    
    Select the InProcessRunner if it is on the classpath, and throw an
    exception otherwise.

commit 9cf1d24d910b2f00ac3dbacc792c9f1d3fc053e0
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-10T21:38:36Z

    Update Direct Module tests to explicitly set Pipeline

commit 140519c8291f9f3a5135b868343aa9b4181889bd
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-10T21:41:06Z

    Use TestPipeline#testingPipelineOptions in IO Tests

commit febf4a14d741f3a9eb1706f8ebdb8d9a9469d3bc
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-10T21:43:10Z

    Move GcsUtil TextIO Tests to TextIOTest
    
    These tests are not a test of the DataflowRunner, nor any
    DataflowRunner specific behavior, so they should be part of TextIOTest

commit cce4dcabe30b109095365830b4d10c300335e17b
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-10T21:45:58Z

    Set Runner in DataflowRunner Tests
    
    Otherwise the Default Runner is used, which may be unavailable.

commit 59371181a0d5af55364840842617c8aa082945a0
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-10T21:47:53Z

    Increase Visibility of Flink Test PipelineOptions
    
    This fixes an issue where the package-private nature would cause an
    exception

commit ecf6ab8097e4ce9a69463578dd74841febc7d84d
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-14T20:18:41Z

    Add DoFnTester#peekOutputValuesInWindow
    
    This permits DoFns that interact with windowing to test the windowed,
    rather than overall output.

commit f1b43b9e18da9fb9ca839c985af93cc491802e31
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-14T20:39:59Z

    Use TimestampedValue in DoFnTester
    
    This removes the duplicate OutputElementWithTimestamp data structure.

commit 11d78a4c1791c1dfd88f0ac348c9c07cd48cafc8
Author: Ian Zhou <ia...@google.com>
Date:   2016-06-09T21:17:14Z

    Modified range tracker to use first response seen as start key

commit ec6d88a787dfdab064bceb70d48b2ce1c5bfa9bb
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-14T01:34:49Z

    Reuse UnboundedReaders in the InProcessRunner
    
    Reuse up to a point, and then discard the reader to exercise resume from
    checkpoint.

commit d2ceaf5e5a778fad18472ab0d7c02a14259015d7
Author: Scott Wegner <sw...@google.com>
Date:   2016-06-14T16:00:49Z

    Update DataflowPipelineRunner worker container version

commit 0065851b96644f2c75b8e51c95ebf0e79c5865f5
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-14T16:27:55Z

    Rename DoFnTester#processBatch to processBundle
    
    DoFns process elements in bundles, not batches.

commit 90bb20ee6738c57bc25f47e2d80690fb721b562e
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-14T22:49:34Z

    Explicitly set the Runner in TestFlinkPipelineRunner
    
    This ensures that the created PipelineOptions are valid if the
    DirectRunner is not on the classpath.

commit 45e57e0612ae692418e07d9c4483321f040cb4a7
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-15T00:51:48Z

    Remove DoFnRunner from GroupAlsoByWindowsProperties
    
    DoFnRunner is a runner implementation detail, and core SDK code should
    instead use DoFnTester.

commit 99654ca4bed6758d7128d0f0ad376e8b479d4eba
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-15T00:52:49Z

    Remove the DirectPipelineRunner from the Core SDK

commit d5e3dfaa864744ec9a011c51707d15f1ab68a734
Author: Scott Wegner <sw...@google.com>
Date:   2016-06-15T16:51:59Z

    Fix NullPointerException in AfterWatermark display data
    
    Window transforms register display data for the associated trigger
    function by calling its .toString() method. The AfterWatermark
    trigger .toString() method was not properly handling cases where
    there is no late firings registered.

commit 340fe3ebcfef0b57b163483d7d7243ad5456ae72
Author: Scott Wegner <sw...@google.com>
Date:   2016-06-15T17:17:01Z

    Package javadoc for org.apache.beam.sdk.transforms.display

commit 6ada1a635382fcddc42a7580e74e755839f7172e
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-15T19:01:56Z

    Run NeedsRunner tests in Runner Core on the DirectRunner
    
    This ensures that all runner tests in runners/core-java are executed in
    the standard maven build.

commit e90a1b9d74cbc06d7818bae8dfe2af81acd73222
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-08T22:07:52Z

    Roll-forwards: Base PAssert on GBK instead of side inputs
    
    Previously PAssert - hence all RunnableOnService/NeedsRunner
    tests - required side input support. This created a very steep
    on ramp for new runners.
    
    GroupByKey is a bit more fundamental and most backends will be
    able to group by key in the global window very quickly. So switching
    the primitive used to gather all the contents of a PCollection for
    assertions should make it a bit easier to get early feedback during
    runner development.

commit 0a7246d268969cb1b7f46149e38361802c95e70a
Author: Scott Wegner <sw...@google.com>
Date:   2016-06-13T18:05:52Z

    Improve BigQueryIO validation for streaming WriteDisposition

commit 605833071a7034aa3b723776a0f9e24330f64c8b
Author: Pei He <pe...@google.com>
Date:   2016-06-13T23:58:01Z

    Replace GcsPath by IOChannelFactory in WordCount.

commit 5bf732cd3e598321a5c51e1239eda0fe2877a65d
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-14T23:04:10Z

    Add test for ReduceFnRunner GC time overflow

commit cfa217a894575f392f1dfe1612e10e393df5c7ab
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-14T23:12:11Z

    Fix type error in Eclipse
    
    This type error occurs in my Eclipse installation. It apparently
    does not bother the various JDKs we test with. But this is an
    accurate typing, so it may help other Eclipse-using contributors,
    too.

commit 8278e5f78f36fb48fae994ee7abcc1485db84189
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-15T17:42:59Z

    [Spark] Elide assigning windows when WindowFn is null
    
    Previously, when translating a Window.Bound transform, the case
    where the WindowFn was null was missed, resulting in a
    NullPointerException.

commit 9400fc9a699f218a7948c21639428f5f00134ec5
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-15T17:45:15Z

    Rename InProcessPipelineRunner to DirectRunner
    
    Completes BEAM-243

commit babddbbc8247bc7322c3fd519a5bf0fa23c57064
Author: Thomas Groh <tg...@google.com>
Date:   2016-06-15T18:21:41Z

    Remove InProcess Prefixes
    
    These prefixes are out of date with the rename of the runner. Most of
    the prefixes are be droped in their entirety, as the classes are scoped
    to the direct runner module.

commit 6460df195240dac4d488fcf111642e8706008690
Author: Jesse Anderson <je...@smokinghand.com>
Date:   2016-05-09T17:05:15Z

    Added BigDecimal coder and tests.

commit 6491100a5d655cb9f6c702767d6354269208f650
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-09T20:24:28Z

    Touch up BigDecimalCoder and tests

commit 8268f1d7ffdd1205a1904037f7dd1e1887a52f8d
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-09T20:24:49Z

    Add BigIntegerCoder and tests

commit 4f7a2ab47c5fdd9b3de5f091a40128e68ddd11a3
Author: Kenneth Knowles <kl...@google.com>
Date:   2016-06-14T23:10:09Z

    Fix overflow in ReduceFnRunner garbage collection times

----


> Add @experimental annotations 
> ------------------------------
>
>                 Key: BEAM-528
>                 URL: https://issues.apache.org/jira/browse/BEAM-528
>             Project: Beam
>          Issue Type: New Feature
>          Components: sdk-py
>            Reporter: Ahmet Altay
>            Priority: Minor
>              Labels: starter
>
> Experimental/deprecation warnings: use the warnings standard module in conjunction with decorators as described here:
> https://docs.python.org/2/library/warnings.html
> Some code sample for a deprecated decorator that is kinda/sorta similar.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)