Merge lp:~diegosarmentero/ubuntuone-client/refactor-remove-windows-linux into lp:ubuntuone-client

[Diego Sarmentero]

- Refactor platform, to move remaining modules inside windows and linux folders.

[Roberto Alsina (ralsina)]

review: Approve

[lp:~diegosarmentero/ubuntuone-client/refactor-remove-windows-linux]

1244. By Diego Sarmentero on 2012-05-14

Fixing pyinotify imports

[Diego Sarmentero (diegosarmentero)]

I think the __init__ from filesystem_notifications is pretty ugly, but the code right now has to be in that way because of lint restriction, maybe we could add this file to the ignore ones in pylintrc and leave the code like this:

if sys.platform == "win32":
    from ubuntuone.platform.filesystem_notifications import pyinotify_agnostic as pyinotify
    ...
else:
    import pyinotify
    ...

Opinions?

[lp:~diegosarmentero/ubuntuone-client/refactor-remove-windows-linux]

1245. By Diego Sarmentero on 2012-05-14

Fixed pyinotify imports

[Manuel de la Peña (mandel)]

SO can we use import as here:

335 +if sys.platform == "win32":
336 + from ubuntuone.platform.logger import windows
337 + source = windows
338 +else:
339 + from ubuntuone.platform.logger import linux
340 + source = linux

and instead do:

from ubuntuone.platform.logger import windows as source

review: Needs Fixing

[Diego Sarmentero (diegosarmentero)]

> SO can we use import as here:
>
> 335 +if sys.platform == "win32":
> 336 + from ubuntuone.platform.logger import windows
> 337 + source = windows
> 338 +else:
> 339 + from ubuntuone.platform.logger import linux
> 340 + source = linux
>
> and instead do:
>
> from ubuntuone.platform.logger import windows as source

This is done this way, because if we do: "as source" for windows and linux, the lint checker fails with:

38: redefinition of unused 'source' from line 35

[Manuel de la Peña (mandel)]

My lord.. stupid pyflakes!

review: Approve

=== modified file 'pylintrc'
--- pylintrc	2011-02-08 11:11:27 +0000
+++ pylintrc	2012-05-14 21:27:19 +0000
@@ -12,7 +12,7 @@
 
 # ignore these specific files
 # pylint has no idea what to do with this, but our wrapper does some magic
-ignore=contrib/mocker.py,ubuntuone/syncdaemon/u1fsfsm.py,ubuntuone/platform/linux/__init__.py,ubuntuone/platform/__init__.py,ubuntuone/platform/windows/__init__.py,ubuntuone/platform/windows/pyinotify.py
+ignore=contrib/mocker.py,ubuntuone/syncdaemon/u1fsfsm.py,ubuntuone/platform/linux/__init__.py,ubuntuone/platform/__init__.py,ubuntuone/platform/windows/__init__.py,ubuntuone/platform/filesystem_notifications/pyinotify_agnostic.py
 
 [MESSAGES CONTROL]
 # Disable some checkers

=== added directory 'tests/platform/credentials'
=== added file 'tests/platform/credentials/__init__.py'
--- tests/platform/credentials/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/platform/credentials/__init__.py	2012-05-14 21:27:19 +0000
@@ -0,0 +1,27 @@
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Credentials test code."""

=== renamed file 'tests/platform/linux/test_credentials.py' => 'tests/platform/credentials/test_linux.py'
=== renamed file 'tests/platform/windows/test_credentials.py' => 'tests/platform/credentials/test_windows.py'
=== modified file 'tests/platform/filesystem_notifications/test_windows.py'
--- tests/platform/filesystem_notifications/test_windows.py	2012-04-30 15:19:03 +0000
+++ tests/platform/filesystem_notifications/test_windows.py	2012-05-14 21:27:19 +0000
@@ -43,7 +43,7 @@
 from contrib.testing.testcase import BaseTwistedTestCase
 from ubuntuone.devtools.handlers import MementoHandler
 from ubuntuone.platform.os_helper import windows as os_helper
-from ubuntuone.platform.windows.pyinotify import (
+from ubuntuone.platform.filesystem_notifications.pyinotify_agnostic import (
     ProcessEvent,
     IN_CLOSE_WRITE,
     IN_CREATE,

=== added directory 'tests/platform/filesystem_notifier'
=== added file 'tests/platform/filesystem_notifier/__init__.py'
--- tests/platform/filesystem_notifier/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/platform/filesystem_notifier/__init__.py	2012-05-14 21:27:19 +0000
@@ -0,0 +1,27 @@
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Platform/File System Notifier (Pyinotify agnostic) test code."""

=== renamed file 'tests/platform/windows/test_pyinotify.py' => 'tests/platform/filesystem_notifier/test_windows.py'
--- tests/platform/windows/test_pyinotify.py	2012-04-09 20:07:05 +0000
+++ tests/platform/filesystem_notifier/test_windows.py	2012-05-14 21:27:19 +0000
@@ -33,7 +33,9 @@
 from twisted.internet import defer
 from twisted.trial.unittest import TestCase
 
-from ubuntuone.platform.windows.pyinotify import RawOutputFormat
+from ubuntuone.platform.filesystem_notifications.pyinotify_agnostic import (
+    RawOutputFormat)
+
 
 class RawOutputFormatTest(TestCase):
     """Test te formatter to ensure it can deal with mbcs."""

=== modified file 'ubuntuone/platform/__init__.py'
--- ubuntuone/platform/__init__.py	2012-04-30 15:19:03 +0000
+++ ubuntuone/platform/__init__.py	2012-05-14 21:27:19 +0000
@@ -37,14 +37,14 @@
 # and to avoid import ubuntuone.platform.X as source (it wont work)
 
 if sys.platform == "win32":
-    from ubuntuone.platform import windows
-    source = windows
+    platform = "win32"
 else:
-    from ubuntuone.platform import linux
-    source = linux
+    platform = "linux"
 
 from ubuntuone.platform import ipc
 from ubuntuone.platform import filesystem_notifications
+from ubuntuone.platform import logger
+from ubuntuone.platform import os_helper
 
 # This imports needs to be here in order to be included in this namespace
 from ubuntuone.platform import credentials
@@ -72,40 +72,39 @@
     return result
 
 
-platform = source.platform
-access = source.access
-allow_writes = source.allow_writes
-can_write = source.can_write
-get_path_list = source.get_path_list
-is_link = source.is_link
-is_root = source.is_root
-listdir = source.listdir
-make_dir = source.make_dir
-make_link = source.make_link
-move_to_trash = source.move_to_trash
-native_rename = source.native_rename
-normpath = source.normpath
-open_file = source.open_file
-path_exists = source.path_exists
-read_link = source.read_link
-recursive_move = source.recursive_move
-remove_dir = source.remove_dir
-remove_file = source.remove_file
-remove_link = source.remove_link
-remove_tree = source.remove_tree
-rename = source.rename
-set_application_name = source.set_application_name
-set_dir_readonly = source.set_dir_readonly
-set_dir_readwrite = source.set_dir_readwrite
-set_file_readonly = source.set_file_readonly
-set_file_readwrite = source.set_file_readwrite
-set_no_rights = source.set_no_rights
-stat_path = source.stat_path
-walk = source.walk
+access = os_helper.access
+allow_writes = os_helper.allow_writes
+can_write = os_helper.can_write
+get_path_list = os_helper.get_path_list
+is_link = os_helper.is_link
+is_root = os_helper.is_root
+listdir = os_helper.listdir
+make_dir = os_helper.make_dir
+make_link = os_helper.make_link
+move_to_trash = os_helper.move_to_trash
+native_rename = os_helper.native_rename
+normpath = os_helper.normpath
+open_file = os_helper.open_file
+path_exists = os_helper.path_exists
+read_link = os_helper.read_link
+recursive_move = os_helper.recursive_move
+remove_dir = os_helper.remove_dir
+remove_file = os_helper.remove_file
+remove_link = os_helper.remove_link
+remove_tree = os_helper.remove_tree
+rename = os_helper.rename
+set_application_name = os_helper.set_application_name
+set_dir_readonly = os_helper.set_dir_readonly
+set_dir_readwrite = os_helper.set_dir_readwrite
+set_file_readonly = os_helper.set_file_readonly
+set_file_readwrite = os_helper.set_file_readwrite
+set_no_rights = os_helper.set_no_rights
+stat_path = os_helper.stat_path
+walk = os_helper.walk
 
 # From Logger
-setup_filesystem_logging = source.setup_filesystem_logging
-get_filesystem_logger = source.get_filesystem_logger
+setup_filesystem_logging = logger.setup_filesystem_logging
+get_filesystem_logger = logger.get_filesystem_logger
 
 # From File System Notifications
 FilesystemMonitor = filesystem_notifications.FilesystemMonitor

=== renamed file 'ubuntuone/platform/windows/pyinotify.py' => 'ubuntuone/platform/filesystem_notifications/pyinotify_agnostic.py'
=== modified file 'ubuntuone/platform/filesystem_notifications/windows.py'
--- ubuntuone/platform/filesystem_notifications/windows.py	2012-04-30 15:19:03 +0000
+++ ubuntuone/platform/filesystem_notifications/windows.py	2012-05-14 21:27:19 +0000
@@ -61,7 +61,7 @@
     SetEvent,
     WaitForMultipleObjects,
     WAIT_OBJECT_0)
-from ubuntuone.platform.windows.pyinotify import (
+from ubuntuone.platform.filesystem_notifications.pyinotify_agnostic import (
     Event,
     WatchManagerError,
     ProcessEvent,

=== removed directory 'ubuntuone/platform/linux'
=== removed file 'ubuntuone/platform/linux/__init__.py'
--- ubuntuone/platform/linux/__init__.py	2012-04-30 18:56:56 +0000
+++ ubuntuone/platform/linux/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,72 +0,0 @@
-# ubuntuone.platform.linux - linux platform imports
-#
-# Copyright 2009-2012 Canonical Ltd.
-#
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU General Public License version 3, as published
-# by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranties of
-# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
-# PURPOSE.  See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-# In addition, as a special exception, the copyright holders give
-# permission to link the code of portions of this program with the
-# OpenSSL library under certain conditions as described in each
-# individual source file, and distribute linked combinations
-# including the two.
-# You must obey the GNU General Public License in all respects
-# for all of the code used other than OpenSSL.  If you modify
-# file(s) with this exception, you may extend this exception to your
-# version of the file(s), but you are not obligated to do so.  If you
-# do not wish to do so, delete this exception statement from your
-# version.  If you delete this exception statement from all source
-# files in the program, then also delete it here.
-"""
-Linux import for ubuntuone-client
-
-This module has to have all linux specific modules and provide the api required
-to support the linux platform."""
-
-platform = "linux"
-
-
-from ubuntuone.platform.os_helper import (
-    access,
-    allow_writes,
-    can_write,
-    get_path_list,
-    is_link,
-    is_root,
-    listdir,
-    make_dir,
-    make_link,
-    move_to_trash,
-    native_rename,
-    normpath,
-    open_file,
-    path_exists,
-    read_link,
-    recursive_move,
-    remove_dir,
-    remove_file,
-    remove_link,
-    remove_tree,
-    rename,
-    set_application_name,
-    set_dir_readonly,
-    set_dir_readwrite,
-    set_file_readonly,
-    set_file_readwrite,
-    set_no_rights,
-    stat_path,
-    walk,
-)
-from ubuntuone.platform.linux.logger import (
-    setup_filesystem_logging,
-    get_filesystem_logger,
-)

=== added directory 'ubuntuone/platform/logger'
=== added file 'ubuntuone/platform/logger/__init__.py'
--- ubuntuone/platform/logger/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/logger/__init__.py	2012-05-14 21:27:19 +0000
@@ -0,0 +1,43 @@
+# -*- coding: utf-8 *-*
+#
+# Copyright 2012 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Logger module."""
+
+import sys
+
+
+if sys.platform == "win32":
+    from ubuntuone.platform.logger import windows
+    source = windows
+else:
+    from ubuntuone.platform.logger import linux
+    source = linux
+
+
+get_filesystem_logger = source.get_filesystem_logger
+setup_filesystem_logging = source.setup_filesystem_logging

=== renamed file 'ubuntuone/platform/linux/logger.py' => 'ubuntuone/platform/logger/linux.py'
--- ubuntuone/platform/linux/logger.py	2012-04-09 20:07:05 +0000
+++ ubuntuone/platform/logger/linux.py	2012-05-14 21:27:19 +0000
@@ -29,6 +29,7 @@
 """Provide platform logging settings."""
 
 import logging
+
 import pyinotify
 
 

=== renamed file 'ubuntuone/platform/windows/logger.py' => 'ubuntuone/platform/logger/windows.py'
=== removed directory 'ubuntuone/platform/windows'
=== removed file 'ubuntuone/platform/windows/__init__.py'
--- ubuntuone/platform/windows/__init__.py	2012-05-04 16:19:07 +0000
+++ ubuntuone/platform/windows/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,76 +0,0 @@
-# ubuntuone.platform.windows - windows platform imports
-#
-# Copyright 2010-2012 Canonical Ltd.
-#
-# This program is free software: you can redistribute it and/or modify it
-# under the terms of the GNU General Public License version 3, as published
-# by the Free Software Foundation.
-#
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranties of
-# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
-# PURPOSE.  See the GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along
-# with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-# In addition, as a special exception, the copyright holders give
-# permission to link the code of portions of this program with the
-# OpenSSL library under certain conditions as described in each
-# individual source file, and distribute linked combinations
-# including the two.
-# You must obey the GNU General Public License in all respects
-# for all of the code used other than OpenSSL.  If you modify
-# file(s) with this exception, you may extend this exception to your
-# version of the file(s), but you are not obligated to do so.  If you
-# do not wish to do so, delete this exception statement from your
-# version.  If you delete this exception statement from all source
-# files in the program, then also delete it here.
-"""
-Windows import for ubuntuone-client
-
-This module has to have all windows specific modules and provide the api
-required to support the windows platform.
-"""
-
-platform = "win32"
-
-
-import logger
-
-from ubuntuone.platform.os_helper import (
-    access,
-    allow_writes,
-    can_write,
-    get_path_list,
-    is_link,
-    is_root,
-    listdir,
-    make_dir,
-    make_link,
-    move_to_trash,
-    native_rename,
-    normpath,
-    open_file,
-    path_exists,
-    read_link,
-    recursive_move,
-    remove_dir,
-    remove_file,
-    remove_link,
-    remove_tree,
-    rename,
-    set_application_name,
-    set_dir_readonly,
-    set_dir_readwrite,
-    set_file_readonly,
-    set_file_readwrite,
-    set_no_rights,
-    stat_path,
-    walk,
-)
-
-from ubuntuone.platform.windows.logger import (
-    setup_filesystem_logging,
-    get_filesystem_logger,
-)

=== modified file 'ubuntuone/syncdaemon/volume_manager.py'
--- ubuntuone/syncdaemon/volume_manager.py	2012-04-09 20:07:05 +0000
+++ ubuntuone/syncdaemon/volume_manager.py	2012-05-14 21:27:19 +0000
@@ -1626,7 +1626,6 @@
         .partial to .u1partial.
 
         """
-        from ubuntuone.platform.linux import allow_writes
         self.log.debug('upgrading from metadata 2 (bogus)')
         for top in self._root_dir, self._shares_dir:
             for dirpath, dirnames, filenames in walk(top):