├── .gitignore ├── filelink ├── __init__.py └── link.py ├── .travis.yml ├── README.md ├── test_filelink.py ├── appveyor.yml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | .cache 3 | -------------------------------------------------------------------------------- /filelink/__init__.py: -------------------------------------------------------------------------------- 1 | from .link import create, HARDLINK 2 | 3 | __all__ = [ 4 | "create", 5 | "HARDLINK" 6 | ] 7 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "2.6" 4 | - "2.7" 5 | - "3.4" 6 | - "3.5" 7 | - "3.6" 8 | install: 9 | - pip install pytest 10 | script: pytest 11 | branches: 12 | only: 13 | - master 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # filelink 2 | A cross platform and file system module for linking files. 3 | 4 | **Currently under development. No features are guaranteed to work.** 5 | 6 | ## Goal 7 | 8 | To provide a simple module for linking files on disk to different locations. 9 | 10 | ## Usage 11 | 12 | This module is as simple as 13 | 14 | ```python 15 | import filelink 16 | filelink.create(src, dst, filelink.HARDLINK) 17 | ``` 18 | -------------------------------------------------------------------------------- /test_filelink.py: -------------------------------------------------------------------------------- 1 | import contextlib 2 | import tempfile 3 | import shutil 4 | import os 5 | 6 | import filelink 7 | 8 | 9 | @contextlib.contextmanager 10 | def tempdir(): 11 | """Provide path to temporary directory""" 12 | try: 13 | tempdir = tempfile.mkdtemp() 14 | yield tempdir 15 | finally: 16 | shutil.rmtree(tempdir) 17 | 18 | 19 | def test_hardlink_creation(): 20 | """Test link creation of hardlink.""" 21 | 22 | with tempdir() as root_dir: 23 | 24 | src = os.path.join(root_dir, "source.txt") 25 | with open(src, "w") as f: 26 | f.write("") 27 | dst = os.path.join(root_dir, "destination.txt") 28 | 29 | filelink.create(src, dst, filelink.HARDLINK) 30 | 31 | assert os.path.exists(dst) 32 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | environment: 2 | 3 | matrix: 4 | 5 | - PYTHON: "C:\\Python266" 6 | PYTHON_VERSION: "2.6.x" 7 | PYTHON_ARCH: "32" 8 | 9 | - PYTHON: "C:\\Python266-x64" 10 | PYTHON_VERSION: "2.6.x" 11 | PYTHON_ARCH: "64" 12 | 13 | - PYTHON: "C:\\Python27" 14 | PYTHON_VERSION: "2.7.x" 15 | PYTHON_ARCH: "32" 16 | 17 | - PYTHON: "C:\\Python27-x64" 18 | PYTHON_VERSION: "2.7.x" 19 | PYTHON_ARCH: "64" 20 | 21 | - PYTHON: "C:\\Python33" 22 | PYTHON_VERSION: "3.3.x" 23 | PYTHON_ARCH: "32" 24 | 25 | - PYTHON: "C:\\Python33-x64" 26 | PYTHON_VERSION: "3.3.x" 27 | PYTHON_ARCH: "64" 28 | 29 | - PYTHON: "C:\\Python34" 30 | PYTHON_VERSION: "3.4.x" 31 | PYTHON_ARCH: "32" 32 | 33 | - PYTHON: "C:\\Python34-x64" 34 | PYTHON_VERSION: "3.4.x" 35 | PYTHON_ARCH: "64" 36 | 37 | - PYTHON: "C:\\Python35" 38 | PYTHON_VERSION: "3.5.x" 39 | PYTHON_ARCH: "32" 40 | 41 | - PYTHON: "C:\\Python35-x64" 42 | PYTHON_VERSION: "3.5.x" 43 | PYTHON_ARCH: "64" 44 | 45 | build: off 46 | 47 | branches: 48 | only: 49 | - master 50 | 51 | install: 52 | - SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH% 53 | - pip install pytest 54 | 55 | test_script: 56 | # Run the project tests 57 | - "%CMD_IN_ENV% pytest" 58 | -------------------------------------------------------------------------------- /filelink/link.py: -------------------------------------------------------------------------------- 1 | import os 2 | import platform 3 | 4 | 5 | HARDLINK = 0 6 | 7 | 8 | def _create_windows(source, destination, link_type): 9 | """Creates hardlink at destination from source in Windows.""" 10 | 11 | if link_type == HARDLINK: 12 | import ctypes 13 | from ctypes.wintypes import BOOL 14 | CreateHardLink = ctypes.windll.kernel32.CreateHardLinkW 15 | CreateHardLink.argtypes = [ 16 | ctypes.c_wchar_p, ctypes.c_wchar_p, ctypes.c_void_p 17 | ] 18 | CreateHardLink.restype = BOOL 19 | 20 | res = CreateHardLink(destination, source, None) 21 | if res == 0: 22 | raise ctypes.WinError() 23 | else: 24 | raise NotImplementedError("Link type unrecognized.") 25 | 26 | 27 | def _create_linux(source, destination, link_type): 28 | """Creates hardlink at destination from source in Linux.""" 29 | 30 | if link_type == HARDLINK: 31 | os.link(source, destination) 32 | else: 33 | raise NotImplementedError("Link type unrecognized.") 34 | 35 | 36 | def _create_osx(source, destination, link_type): 37 | """Creates hardlink at destination from source in OSX.""" 38 | # OSX is not supported yet, as testing on Travis does not support Python 39 | # natively. 40 | raise NotImplementedError("OSX is not support yet.") 41 | 42 | 43 | def create(source, destination, link_type=HARDLINK): 44 | """Creates a hardlink at destination referring to the same file.""" 45 | 46 | system = platform.system() 47 | 48 | if system == "Windows": 49 | _create_windows(source, destination, link_type) 50 | elif system == "Linux": 51 | _create_linux(source, destination, link_type) 52 | elif system == "Darwin": 53 | _create_osx(source, destination, link_type) 54 | else: 55 | raise NotImplementedError( 56 | "Unsupported platform: \"{0}\"".format(system) 57 | ) 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | --------------------------------------------------------------------------------