Merge pull request #1216 from njgheorghita/pm-api-unstable-flag

Disable pm api by default

docs/web3.pm.rst

@@ -8,15 +8,30 @@ To learn more about the EthPM spec, visit the `documentation <http://ethpm.githu
 To learn more about the Py-EthPM library used in this module, visit the `documentation <https://py-ethpm.readthedocs.io/en/latest/>`__.
 
 
-Attaching
----------
-  To use ``web3.pm``, attach it to your ``web3`` instance.
-
- .. code-block:: python
- 	 
-    from web3.pm import PM
-    PM.attach(web3, 'pm')
- 	 
+.. WARNING::
+
+   The ``web3.pm`` API is still under development and likely to change quickly.
+
+   Now is a great time to get familiar with the API, and test out writing
+   code that uses some of the great upcoming features.
+
+   By default, access to this module has been turned off in the stable version of Web3.py:
+
+   .. code-block:: python
+
+      >>> from web3.auto import w3
+      >>> w3.pm
+      ...
+      AttributeError: The Package Management feature is disabled by default ...
+
+   In order to access these features, you can turn it on with...
+
+   .. code-block:: python
+
+      >>> web3.enable_unstable_package_management_api()
+      >>> w3.pm
+      <web3.pm.PM at 0x....>
+
 
 Methods
 -------

tests/core/pm-module/conftest.py

@@ -27,7 +27,6 @@
 
 from web3 import Web3
 from web3.pm import (
-    PM,
     SolidityReferenceRegistry,
     VyperReferenceRegistry,
 )
@@ -61,7 +60,7 @@ def setup_w3():
     w3 = Web3(Web3.EthereumTesterProvider(ethereum_tester=t))
     w3.eth.defaultAccount = w3.eth.accounts[0]
     w3.eth.defaultContractFactory = LinkableContract
-    PM.attach(w3, 'pm')
+    w3.enable_unstable_package_management_api()
     return w3
 
 

tests/core/pm-module/test_ens_integration.py

@@ -13,7 +13,6 @@
     InvalidAddress,
 )
 from web3.pm import (
-    PM,
     VyperReferenceRegistry,
 )
 
@@ -119,19 +118,18 @@ def ens_setup(deployer):
 def ens(ens_setup, mocker):
     mocker.patch('web3.middleware.stalecheck._isfresh', return_value=True)
     ens_setup.web3.eth.defaultAccount = ens_setup.web3.eth.coinbase
+    ens_setup.web3.enable_unstable_package_management_api()
     return ens_setup
 
 
 def test_ens_must_be_set_before_ens_methods_can_be_used(ens):
     w3 = ens.web3
-    PM.attach(w3, 'pm')
     with pytest.raises(InvalidAddress):
         w3.pm.set_registry("tester.eth")
 
 
 def test_web3_ens(ens):
     w3 = ens.web3
-    PM.attach(w3, 'pm')
     ns = ENS.fromWeb3(w3, ens.ens.address)
     w3.ens = ns
     registry = VyperReferenceRegistry.deploy_new_instance(w3)

tests/core/pm-module/test_registry_integration.py

@@ -16,7 +16,6 @@
     PMError,
 )
 from web3.pm import (
-    PM,
     ERCRegistry,
     VyperReferenceRegistry,
     get_vyper_registry_manifest,
@@ -28,7 +27,7 @@ def fresh_w3():
     w3 = Web3(Web3.EthereumTesterProvider())
     w3.eth.defaultAccount = w3.eth.accounts[0]
     w3.eth.defaultContractFactory = LinkableContract
-    PM.attach(w3, "pm")
+    w3.enable_unstable_package_management_api()
     return w3
 
 

web3/main.py

@@ -206,3 +206,18 @@ def ens(self):
     @ens.setter
     def ens(self, new_ens):
         self._ens = new_ens
+
+    @property
+    def pm(self):
+        if self._pm is not None:
+            return self._pm
+        else:
+            raise AttributeError(
+                "The Package Management feature is disabled by default until "
+                "its API stabilizes. To use these features, please enable them by running "
+                "`w3.enable_unstable_package_management_api()` and try again."
+            )
+
+    def enable_unstable_package_management_api(self):
+        from web3.pm import PM
+        PM.attach(self, '_pm')