mac-alias 2.0.1__tar.gz → 2.0.4__tar.gz

{mac_alias-2.0.1 → mac_alias-2.0.4}/PKG-INFO

@@ -1,12 +1,25 @@
 Metadata-Version: 1.1
 Name: mac_alias
-Version: 2.0.1
+Version: 2.0.4
 Summary: Generate/parse Mac OS Alias records from Python
 Home-page: http://alastairs-place.net/projects/mac_alias
 Author: Alastair Houghton
 Author-email: alastair@alastairs-place.net
 License: MIT License
-Description: ``mac_alias`` lets you generate or read binary Alias and Bookmark records
+Description: =========
+        mac_alias
+        =========
+        
+        .. image:: https://travis-ci.org/al45tair/mac_alias.svg?branch=master
+            :target: https://travis-ci.org/al45tair/mac_alias
+        
+        .. image:: https://readthedocs.org/projects/mac_alias/badge/?version=latest
+            :target: http://mac_alias.readthedocs.io/en/latest/?badge=latest
+        
+        What is this?
+        -------------
+        
+        ``mac_alias`` lets you generate or read binary Alias and Bookmark records
         from Python code.
         
         While it is written in pure Python, some OS X specific code is required to
@@ -18,6 +31,10 @@ Description: ``mac_alias`` lets you generate or read binary Alias and Bookmark r
         <alastair@alastairs-place.net> was responsible for reverse engineering the
         bookmark format.
         
+        See the documentation_ for more information.
+        
+        .. _documentation:: http://mac-alias.rtfd.org
+        
 Platform: darwin
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License

{mac_alias-2.0.1 → mac_alias-2.0.4}/README.rst

@@ -1,3 +1,16 @@
+=========
+mac_alias
+=========
+
+.. image:: https://travis-ci.org/al45tair/mac_alias.svg?branch=master
+    :target: https://travis-ci.org/al45tair/mac_alias
+
+.. image:: https://readthedocs.org/projects/mac_alias/badge/?version=latest
+    :target: http://mac_alias.readthedocs.io/en/latest/?badge=latest
+
+What is this?
+-------------
+
 ``mac_alias`` lets you generate or read binary Alias and Bookmark records
 from Python code.
 
@@ -9,3 +22,7 @@ Credit is due to Wim Lewis <wiml@hhhh.org>, whose work on reverse engineering
 the alias format was extremely useful in writing this code.  Alastair Houghton
 <alastair@alastairs-place.net> was responsible for reverse engineering the
 bookmark format.
+
+See the documentation_ for more information.
+
+.. _documentation:: http://mac-alias.rtfd.org

{mac_alias-2.0.1 → mac_alias-2.0.4}/mac_alias/alias.py

@@ -14,6 +14,11 @@ import sys
 if sys.platform == 'darwin':
     from . import osx
 
+try:
+    long
+except NameError:
+    long = int
+
 from .utils import *
     
 ALIAS_KIND_FILE = 0
@@ -30,6 +35,16 @@ ALIAS_EJECTABLE_DISK = 5
 
 ALIAS_NO_CNID = 0xffffffff
 
+def encode_utf8(s):
+    if isinstance(s, bytes):
+        return s
+    return s.encode('utf-8')
+
+def decode_utf8(s):
+    if isinstance(s, bytes):
+        return s.decode('utf-8')
+    return s
+
 class AppleShareInfo (object):
     def __init__(self, zone=None, server=None, user=None):
         #: The AppleShare zone
@@ -323,6 +338,8 @@ class Alias (object):
         """Create an :class:`Alias` that points at the specified file."""
         if sys.platform != 'darwin':
             raise Exception('Not implemented (requires special support)')
+
+        path = encode_utf8(path)
         
         a = Alias()
 
@@ -337,7 +354,7 @@ class Alias (object):
         volinfo = osx.getattrlist(vol_path, attrs, 0)
 
         vol_crtime = volinfo[0]
-        vol_name = volinfo[1]
+        vol_name = encode_utf8(volinfo[1])
         
         # Also grab various attributes of the file
         attrs = [(osx.ATTR_CMN_OBJTYPE
@@ -357,7 +374,7 @@ class Alias (object):
         
         dirname, filename = os.path.split(path)
 
-        if dirname == '' or dirname == '.':
+        if dirname == b'' or dirname == b'.':
             dirname = os.getcwd()
 
         foldername = os.path.basename(dirname)
@@ -382,10 +399,10 @@ class Alias (object):
         rel_path = os.path.relpath(path, vol_path)
 
         # Leave off the initial '/' if vol_path is '/' (no idea why)
-        if vol_path == '/':
+        if vol_path == b'/':
             a.target.posix_path = rel_path
         else:
-            a.target.posix_path = '/' + rel_path
+            a.target.posix_path = b'/' + rel_path
 
         # Construct the Carbon and CNID paths
         carbon_path = []
@@ -398,10 +415,11 @@ class Alias (object):
                 attrs = [osx.ATTR_CMN_FILEID, 0, 0, 0, 0]
                 info = osx.getattrlist(os.path.join(vol_path, head), attrs, 0)
                 cnid_path.append(info[0])
-            carbon_tail = tail.replace(':','/')
+            carbon_tail = tail.replace(b':',b'/')
             carbon_path.insert(0, carbon_tail)
             head, tail = os.path.split(head)
-        carbon_path = vol_name + ':' + ':\0'.join(carbon_path)
+
+        carbon_path = vol_name + b':' + b':\0'.join(carbon_path)
 
         a.target.carbon_path = carbon_path
         a.target.cnid_path = cnid_path
@@ -413,8 +431,8 @@ class Alias (object):
         pos = b.tell()
         b.write(struct.pack(b'>4shh', self.appinfo, 0, self.version))
 
-        carbon_volname = self.volume.name.replace(':','/').encode('utf-8')
-        carbon_filename = self.target.filename.replace(':','/').encode('utf-8')
+        carbon_volname = encode_utf8(self.volume.name).replace(b':',b'/')
+        carbon_filename = encode_utf8(self.target.filename).replace(b':',b'/')
         voldate = (self.volume.creation_date - mac_epoch).total_seconds()
         crdate = (self.target.creation_date - mac_epoch).total_seconds()
 
@@ -422,13 +440,13 @@ class Alias (object):
         #       (so doing so is ridiculous, and nothing could rely on it).
         b.write(struct.pack(b'>h28pI2shI64pII4s4shhI2s10s',
                             self.target.kind,
-                            carbon_volname, voldate,
+                            carbon_volname, int(voldate),
                             self.volume.fs_type,
                             self.volume.disk_type,
                             self.target.folder_cnid,
                             carbon_filename,
                             self.target.cnid,
-                            crdate,
+                            int(crdate),
                             self.target.creator_code,
                             self.target.type_code,
                             self.target.levels_from,
@@ -439,8 +457,8 @@ class Alias (object):
 
         # Excuse the odd order; we're copying Finder
         if self.target.folder_name:
-            carbon_foldername = self.target.folder_name.replace(':','/')\
-              .encode('utf-8')
+            carbon_foldername = encode_utf8(self.target.folder_name)\
+                                .replace(b':',b'/')
             b.write(struct.pack(b'>hh', TAG_CARBON_FOLDER_NAME,
                                 len(carbon_foldername)))
             b.write(carbon_foldername)
@@ -461,7 +479,7 @@ class Alias (object):
             b.write(cnid_path)
 
         if self.target.carbon_path:
-            carbon_path=self.target.carbon_path.encode('utf-8')
+            carbon_path=encode_utf8(self.target.carbon_path)
             b.write(struct.pack(b'>hh', TAG_CARBON_PATH,
                                  len(carbon_path)))
             b.write(carbon_path)
@@ -490,7 +508,7 @@ class Alias (object):
                     b.write(b'\0')
 
         if self.volume.driver_name:
-            driver_name = self.volume.driver_name.encode('utf-8')
+            driver_name = encode_utf8(self.volume.driver_name)
             b.write(struct.pack(b'>hh', TAG_DRIVER_NAME,
                                 len(driver_name)))
             b.write(driver_name)
@@ -511,20 +529,22 @@ class Alias (object):
             if len(self.volume.network_mount_info) & 1:
                 b.write(b'\0')
 
-        utf16 = self.target.filename.replace(':','/').encode('utf-16-be')
+        utf16 = decode_utf8(self.target.filename)\
+                .replace(':','/').encode('utf-16-be')
         b.write(struct.pack(b'>hhh', TAG_UNICODE_FILENAME,
                             len(utf16) + 2,
                             len(utf16) // 2))
         b.write(utf16)
 
-        utf16 = self.volume.name.replace(':','/').encode('utf-16-be')
+        utf16 = decode_utf8(self.volume.name)\
+                .replace(':','/').encode('utf-16-be')
         b.write(struct.pack(b'>hhh', TAG_UNICODE_VOLUME_NAME,
                             len(utf16) + 2,
                             len(utf16) // 2))
         b.write(utf16)
 
         if self.target.posix_path:
-            posix_path = self.target.posix_path.encode('utf-8')
+            posix_path = encode_utf8(self.target.posix_path)
             b.write(struct.pack(b'>hh', TAG_POSIX_PATH,
                                 len(posix_path)))
             b.write(posix_path)
@@ -532,7 +552,7 @@ class Alias (object):
                 b.write(b'\0')
 
         if self.volume.posix_path:
-            posix_path = self.volume.posix_path.encode('utf-8')
+            posix_path = encode_utf8(self.volume.posix_path)
             b.write(struct.pack(b'>hh', TAG_POSIX_PATH_TO_MOUNTPOINT,
                                 len(posix_path)))
             b.write(posix_path)

{mac_alias-2.0.1 → mac_alias-2.0.4}/mac_alias/bookmark.py

@@ -4,7 +4,7 @@
 #  for the old-fashioned alias format.  The details of this format were
 #  reverse engineered; some things are still not entirely clear.
 #
-from __future__ import unicode_literals
+from __future__ import unicode_literals, print_function
 
 import struct
 import uuid
@@ -13,11 +13,26 @@ import os
 import sys
 import pprint
 
-from urlparse import urljoin
+try:
+    from urlparse import urljoin
+except ImportError:
+    from urllib.parse import urljoin
 
 if sys.platform == 'darwin':
     from . import osx
 
+def iteritems(x):
+    return x.iteritems()
+
+try:
+    unicode
+except NameError:
+    unicode = str
+    long = int
+    xrange = range
+    def iteritems(x):
+        return x.items()
+
 from .utils import *
 
 BMK_DATA_TYPE_MASK    = 0xffffff00
@@ -292,7 +307,7 @@ class Bookmark (object):
         elif dtype == BMK_NULL:
             return None
 
-        print 'Unknown data type %08x' % typecode
+        print('Unknown data type %08x' % typecode)
         return (typecode, databytes)
 
     @classmethod
@@ -304,8 +319,8 @@ class Bookmark (object):
 
         magic,size,dummy,hdrsize = struct.unpack(b'<4sIII', data[0:16])
 
-        if magic != 'book':
-            raise ValueError('Not a bookmark file (bad magic)')
+        if magic != b'book':
+            raise ValueError('Not a bookmark file (bad magic) %r' % magic)
 
         if hdrsize < 16:
             raise ValueError('Not a bookmark file (header size too short)')
@@ -442,7 +457,7 @@ class Bookmark (object):
             ioffset = offset + 8 + len(item) * 8
             result = [struct.pack(b'<II', len(item) * 8, BMK_DICT | BMK_ST_ONE)]
             enc = []
-            for k,v in item.iteritems():
+            for k,v in iteritems(item):
                 result.append(struct.pack(b'<I', ioffset))
                 ioffset, ienc = cls._encode_item(k, ioffset)
                 enc.append(ienc)
@@ -476,8 +491,8 @@ class Bookmark (object):
         for tid,toc in self.tocs:
             entries = []
 
-            for k,v in toc.iteritems():
-                if isinstance(k, basestring):
+            for k,v in iteritems(toc):
+                if isinstance(k, (str, unicode)):
                     noffset = offset
                     voffset, enc = self._encode_item(k, offset)
                     result.append(enc)
@@ -510,7 +525,7 @@ class Bookmark (object):
                                       0xfffffffe,
                                       tid,
                                       next_offset,
-                                      len(data) / 12))
+                                      len(data) // 12))
             result.append(data)
 
             offset += 20 + len(data)
@@ -533,7 +548,7 @@ class Bookmark (object):
 
         # Find the filesystem
         st = osx.statfs(path)
-        vol_path = st.f_mntonname
+        vol_path = st.f_mntonname.decode('utf-8')
 
         # Grab its attributes
         attrs = [osx.ATTR_CMN_CRTIME,
@@ -580,6 +595,9 @@ class Bookmark (object):
 
         foldername = os.path.basename(dirname)
 
+        print(repr(path))
+        print(repr(vol_path))
+        
         rel_path = os.path.relpath(path, vol_path)
 
         # Build the path arrays
@@ -606,6 +624,12 @@ class Bookmark (object):
         volprops = Data(struct.pack(b'<QQQ', 0x81 | kCFURLVolumeSupportsPersistentIDs,
                                     0x13ef | kCFURLVolumeSupportsPersistentIDs, 0))
 
+        print(repr(name_path))
+        print(repr(cnid_path))
+        print(repr(fileprops))
+        print(repr(vol_path))
+        print(repr(vol_name))
+
         toc = {
             kBookmarkPath: name_path,
             kBookmarkCNIDPath: cnid_path,
@@ -635,8 +659,8 @@ class Bookmark (object):
         result = ['Bookmark([']
         for tid,toc in self.tocs:
             result.append('(0x%x, {\n' % tid)
-            for k,v in toc.iteritems():
-                if isinstance(k, basestring):
+            for k,v in iteritems(toc):
+                if isinstance(k, (str, unicode)):
                     kf = repr(k)
                 else:
                     kf = '0x%04x' % k

{mac_alias-2.0.1 → mac_alias-2.0.4}/mac_alias/osx.py

@@ -434,7 +434,7 @@ def _datetime_from_timespec(ts):
     return unix_epoch + td
 
 def _decode_utf8_nul(sz):
-    nul = sz.find('\0')
+    nul = sz.find(b'\0')
     if nul > -1:
         sz = sz[:nul]
     return sz.decode('utf-8')
@@ -757,6 +757,8 @@ def _get_errno():
     return __error().contents.value
                 
 def getattrlist(path, attrs, options):
+    if not isinstance(path, bytes):
+        path = path.encode('utf-8')
     attrs = list(attrs)
     if attrs[1]:
         attrs[1] |= ATTR_VOL_INFO
@@ -805,6 +807,8 @@ def fgetattrlist(fd, attrs, options):
     return _decode_attrlist_result(buf, attrs, options)
 
 def statfs(path):
+    if not isinstance(path, bytes):
+        path = path.encode('utf-8')
     result = struct_statfs()
     ret = _statfs(path, byref(result))
     if ret < 0:

{mac_alias-2.0.1 → mac_alias-2.0.4}/mac_alias.egg-info/PKG-INFO

@@ -1,12 +1,25 @@
 Metadata-Version: 1.1
 Name: mac-alias
-Version: 2.0.1
+Version: 2.0.4
 Summary: Generate/parse Mac OS Alias records from Python
 Home-page: http://alastairs-place.net/projects/mac_alias
 Author: Alastair Houghton
 Author-email: alastair@alastairs-place.net
 License: MIT License
-Description: ``mac_alias`` lets you generate or read binary Alias and Bookmark records
+Description: =========
+        mac_alias
+        =========
+        
+        .. image:: https://travis-ci.org/al45tair/mac_alias.svg?branch=master
+            :target: https://travis-ci.org/al45tair/mac_alias
+        
+        .. image:: https://readthedocs.org/projects/mac_alias/badge/?version=latest
+            :target: http://mac_alias.readthedocs.io/en/latest/?badge=latest
+        
+        What is this?
+        -------------
+        
+        ``mac_alias`` lets you generate or read binary Alias and Bookmark records
         from Python code.
         
         While it is written in pure Python, some OS X specific code is required to
@@ -18,6 +31,10 @@ Description: ``mac_alias`` lets you generate or read binary Alias and Bookmark r
         <alastair@alastairs-place.net> was responsible for reverse engineering the
         bookmark format.
         
+        See the documentation_ for more information.
+        
+        .. _documentation:: http://mac-alias.rtfd.org
+        
 Platform: darwin
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License

{mac_alias-2.0.1 → mac_alias-2.0.4}/setup.py

@@ -1,11 +1,25 @@
 # -*- coding: utf-8 -*-
+import sys
 from setuptools import setup
 
-with open('README.rst', 'r') as f:
+from setuptools.command.test import test as TestCommand
+
+class PyTest(TestCommand):
+    def finalize_options(self):
+        TestCommand.finalize_options(self)
+        self.test_args = []
+        self.test_suite = True
+
+    def run_tests(self):
+        import pytest
+        errno = pytest.main(self.test_args)
+        sys.exit(errno)
+
+with open('README.rst', 'rb') as f:
     longdesc = f.read().decode('utf-8')
 
 setup(name='mac_alias',
-      version='2.0.1',
+      version='2.0.4',
       description='Generate/parse Mac OS Alias records from Python',
       long_description=longdesc,
       author='Alastair Houghton',
@@ -19,4 +33,8 @@ setup(name='mac_alias',
           'License :: OSI Approved :: MIT License',
           'Topic :: Desktop Environment',
           'Topic :: Software Development :: Libraries :: Python Modules'],
+      tests_require=['pytest'],
+      cmdclass={
+          'test': PyTest
+          },
       provides=['mac_alias'])