Merge lp:~bialix/bzr/deprecate into lp:bzr

[Alexander Belchenko]

`decode` parameter to get() method in FtpTransport and GioTransport classes is deprecated.

this patch fixes todo in FtpTransport.get() about decode parameter. That parameter is not used actually. While fixing this I found that GioTransport has the same parameter (I smell copy-paste ;-). So I've deprecated decode there as well.

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 8/25/2010 5:26 AM, Alexander Belchenko wrote:
> Alexander Belchenko has proposed merging lp:~bialix/bzr/deprecate into lp:bzr.
>
> Requested reviews:
> bzr-core (bzr-core)
>
>
> this patch fixes todo in FtpTransport.get() about decode parameter. That parameter is not used actually. While fixing this I found that GioTransport has the same parameter (I smell copy-paste ;-). So I've deprecated decode there as well.

I really don't know what 'decode' was meant to be doing, as at present
there are no calls *to* get that pass decode.

We should check that it isn't used by bzr-upload or something like that.
Otherwise, looks good to me.

 merge: approve

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkx1HuIACgkQJdeBCYSNAANFpQCgyPeWt9BuEXVIGTGy4ken6fzD
JngAoIvoHHCse4WFMTqe7OBH4yJJ2Srf
=Yr01
-----END PGP SIGNATURE-----

review: Approve

[Alexander Belchenko (bialix)]

I've checked upload plugin sources, and as I can see there is no use of transport.get, only transport.get_bytes.

[Vincent Ladeuil (vila)]

>>>>> John A Meinel <email address hidden> writes:

    > Review: Approve
    > On 8/25/2010 5:26 AM, Alexander Belchenko wrote:
    >> Alexander Belchenko has proposed merging lp:~bialix/bzr/deprecate into lp:bzr.
    >>
    >> Requested reviews:
    >> bzr-core (bzr-core)
    >>
    >>
    >> this patch fixes todo in FtpTransport.get() about decode parameter. That parameter is not used actually. While fixing this I found that GioTransport has the same parameter (I smell copy-paste ;-). So I've deprecated decode there as well.

    > I really don't know what 'decode' was meant to be doing, as at present
    > there are no calls *to* get that pass decode.

    > We should check that it isn't used by bzr-upload or something like that.

Nope. No idea what it means (though I could guess ;)

[John A Meinel (jameinel)]

sent to pqm by email

=== modified file 'NEWS'
--- NEWS	2010-08-24 23:20:14 +0000
+++ NEWS	2010-08-25 10:25:58 +0000
@@ -20,6 +20,9 @@
   is now named "msg" instead of earlier "message".
   (Parth Malwankar, #603461)
 
+* `decode` parameter to get() method in FtpTransport and GioTransport classes
+  is deprecated. (Alexander Belchenko)
+
 * `FileInWrongBranch` is deprecated in favour of `PathNotChild` and no
   longer raised.
   (Martin Pool)
 
=== modified file 'bzrlib/transport/ftp/__init__.py'
--- bzrlib/transport/ftp/__init__.py	2010-08-18 01:29:12 +0000
+++ bzrlib/transport/ftp/__init__.py	2010-08-25 10:25:58 +0000
@@ -40,6 +40,12 @@
     osutils,
     urlutils,
     )
+from bzrlib.symbol_versioning import (
+    DEPRECATED_PARAMETER,
+    deprecated_in,
+    deprecated_passed,
+    warn,
+    )
 from bzrlib.trace import mutter, warning
 from bzrlib.transport import (
     AppendBasedFileStream,
@@ -235,7 +241,7 @@
             mutter("FTP has not: %s: %s", abspath, e)
             return False
 
-    def get(self, relpath, decode=False, retries=0):
+    def get(self, relpath, decode=DEPRECATED_PARAMETER, retries=0):
         """Get the file at the given relative path.
 
         :param relpath: The relative path to the file
@@ -245,7 +251,10 @@
         We're meant to return a file-like object which bzr will
         then read from. For now we do this via the magic of StringIO
         """
-        # TODO: decode should be deprecated
+        if deprecated_passed(decode):
+            warn(deprecated_in((2,3,0)) %
+                 '"decode" parameter to FtpTransport.get()',
+                 DeprecationWarning, stacklevel=2)
         try:
             mutter("FTP get: %s", self._remote_path(relpath))
             f = self._get_FTP()
 
=== modified file 'bzrlib/transport/gio_transport.py'
--- bzrlib/transport/gio_transport.py	2010-05-28 18:52:03 +0000
+++ bzrlib/transport/gio_transport.py	2010-08-25 10:25:58 +0000
@@ -43,6 +43,12 @@
     debug,
     ui,
     )
+from bzrlib.symbol_versioning import (
+    DEPRECATED_PARAMETER,
+    deprecated_in,
+    deprecated_passed,
+    warn,
+    )
 from bzrlib.trace import mutter, warning
 from bzrlib.transport import (
     FileStream,
@@ -262,7 +268,7 @@
             else:
                 self._translate_gio_error(e, relpath)
 
-    def get(self, relpath, decode=False, retries=0):
+    def get(self, relpath, decode=DEPRECATED_PARAMETER, retries=0):
         """Get the file at the given relative path.
 
         :param relpath: The relative path to the file
@@ -272,6 +278,10 @@
         We're meant to return a file-like object which bzr will
         then read from. For now we do this via the magic of StringIO
         """
+        if deprecated_passed(decode):
+            warn(deprecated_in((2,3,0)) %
+                 '"decode" parameter to GioTransport.get()',
+                 DeprecationWarning, stacklevel=2)
         try:
             if 'gio' in debug.debug_flags:
                 mutter("GIO get: %s" % relpath)