Python compatibility guidelines by liyanhui1228 · Pull Request #169 · GoogleCloudPlatform/cloud-opensource-python

liyanhui1228 · 2018-10-23T00:10:48Z

Closes #113

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

brianquinlan · 2018-10-24T17:55:24Z

+
+- It’s not recommended to depend on non-GA packages.
+- Avoid depending on pre-release, post-release and development release version.
+- Dependency version should be final release. (`PEP 440`_)


I don't know what this means.

This is actually saying the same thing as the point above, any version which is not a pre-release, post-release and development release is a final release. Removed this point.

brianquinlan · 2018-10-24T17:56:40Z

+- It’s not recommended to depend on non-GA packages.
+- Avoid depending on pre-release, post-release and development release version.
+- Dependency version should be final release. (`PEP 440`_)
+- GA packages must not depend on non-GA packages.


Does your use of SHOULD and MUST match RFC terminology: https://www.ietf.org/rfc/rfc2119.txt

Yes, mentioned this at the top of this file.

brianquinlan · 2018-10-24T17:59:26Z

+- Dependency version should be final release. (`PEP 440`_)
+- GA packages must not depend on non-GA packages.
+
+**3. Version range upper bound should be updated when there is a newer version available as soon as possible.**


Didn't you already make this point?

Oh I was thinking making this a separate point to emphasize on it.. and forgot to delete it from the sub-point in. Removed.

brianquinlan · 2018-10-24T17:59:53Z

+
+- Packages should use Python built-in modules if possible. e.g. logging, unittest
+
+**5. Never vendor dependencies**


You should explain what this means

brianquinlan · 2018-10-24T18:01:06Z

+
+- Package must be self compatible
+If package A depends on dependency B and C, and they require different version
+of dependency D, package A is not self compatible. Packages that are not self


maybe "internally" rather than self?

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

googlebot · 2018-10-24T18:20:59Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

googlebot · 2018-10-24T18:21:06Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

…ensource-python into guidelines

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

…ensource-python into guidelines

googlebot · 2018-10-24T20:02:46Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

googlebot · 2018-10-24T20:04:00Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

googlebot · 2018-10-24T20:04:29Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

googlebot · 2018-10-29T23:24:45Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

…ensource-python into guidelines

googlebot · 2018-10-30T00:55:04Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

liyanhui1228 · 2018-11-01T23:00:40Z

Ping on this.

brianquinlan · 2018-10-30T01:48:44Z

+- A package makes breaking API changes and doesn't follow `Semantic Versioning`_
+- A package has a pinned dependency version which conflicts with other dependencies.
+- A package depends on outdated dependencies.
+- A package is dependent on deprecated dependencies.


Is there any way to automate detection of deprecated dependencies? It looks like pypi doesn't really have a concept of a deprecated package.

Currently the deprecated dependency finder tool in our compatibility_lib uses the development status field in setup.py to determine whether a package is deprecated or not. If one pkg is deprecated, the status should be Development Status :: 7 - Inactive.

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

googlebot · 2018-11-14T23:16:37Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

googlebot · 2018-11-14T23:16:42Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

googlebot · 2018-11-15T00:10:55Z

A Googler has manually verified that the CLAs look good.

(Googler, please make sure the reason for overriding the CLA status is clearly documented in these comments.)

liyanhui1228 added 3 commits October 22, 2018 16:57

Add best practices

0df0383

Add links

af4e372

fix

e10be8e

liyanhui1228 requested review from brianquinlan and ylil93 October 23, 2018 00:10

ylil93 suggested changes Oct 24, 2018

View reviewed changes

ylil93 and others added 3 commits October 24, 2018 10:34

Update best_practices/README.rst

fce9680

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

cdbf3a4

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

2113ee2

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

brianquinlan suggested changes Oct 24, 2018

View reviewed changes

Update best_practices/README.rst

b159342

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

liyanhui1228 and others added 8 commits October 24, 2018 11:21

resolve comments

71a9095

Merge branch 'guidelines' of https://github.com/liyanhui1228/cloud-op…

04b8cb4

…ensource-python into guidelines

Update best_practices/README.rst

5e1df83

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

a6bc4e1

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

6dcf667

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

fe7687d

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Resolve conflicts

16feacb

Merge branch 'guidelines' of https://github.com/liyanhui1228/cloud-op…

f0791d2

…ensource-python into guidelines

liyanhui1228 added the cla: yes label Oct 24, 2018

fix

41fe272

googlebot added cla: no and removed cla: yes labels Oct 24, 2018

liyanhui1228 added cla: yes and removed cla: no labels Oct 24, 2018

googlebot added cla: no and removed cla: yes labels Oct 29, 2018

Update best_practices/README.rst

4777adf

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

brianquinlan and others added 8 commits October 29, 2018 16:24

Update best_practices/README.rst

a010ce0

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

feb8863

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

e47b7d0

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

83729b8

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

28e1834

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

Update best_practices/README.rst

cc6d333

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

resolve comments

62f5520

Merge branch 'guidelines' of https://github.com/liyanhui1228/cloud-op…

8f2ad36

…ensource-python into guidelines

liyanhui1228 added cla: yes and removed cla: no labels Oct 30, 2018

ylil93 approved these changes Nov 1, 2018

View reviewed changes

brianquinlan suggested changes Nov 14, 2018

View reviewed changes

Update best_practices/README.rst

7031ab3

Co-Authored-By: liyanhui1228 <yanhuil@google.com>

googlebot added cla: no and removed cla: yes labels Nov 14, 2018

Merge branch 'master' into guidelines

4ff4e9e

brianquinlan approved these changes Nov 15, 2018

View reviewed changes

liyanhui1228 added cla: yes and removed cla: no labels Nov 15, 2018

liyanhui1228 merged commit 685a873 into GoogleCloudPlatform:master Nov 15, 2018

liyanhui1228 deleted the guidelines branch November 15, 2018 00:11


		- Packages should use Python built-in modules if possible. e.g. logging, unittest

		5. Never vendor dependencies

Conversation

liyanhui1228 commented Oct 23, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

googlebot commented Oct 24, 2018

Uh oh!

googlebot commented Oct 24, 2018

Uh oh!

googlebot commented Oct 24, 2018

Uh oh!

googlebot commented Oct 24, 2018

Uh oh!

googlebot commented Oct 24, 2018

Uh oh!

googlebot commented Oct 29, 2018

Uh oh!

googlebot commented Oct 30, 2018

Uh oh!

liyanhui1228 commented Nov 1, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

googlebot commented Nov 14, 2018

Uh oh!

googlebot commented Nov 14, 2018

Uh oh!

googlebot commented Nov 15, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

liyanhui1228 commented Oct 23, 2018 •

edited

Loading