physfs.py 0.0.2__tar.gz

physfs.py-0.0.2/LICENSE

@@ -0,0 +1,36 @@
+Copyright (c) 2016 The Pybind Development Team, All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+You are under no obligation whatsoever to provide any bug fixes, patches, or
+upgrades to the features, functionality or performance of the source code
+("Enhancements") to anyone; however, if you choose to make your Enhancements
+available either publicly, or directly to the author of this software, without
+imposing a separate written license agreement for such Enhancements, then you
+hereby grant the following license: a non-exclusive, royalty-free perpetual
+license to install, use, modify, prepare derivative works, incorporate into
+other computer software, distribute, and sublicense such enhancements or
+derivative works thereof, in binary and source code form.

physfs.py-0.0.2/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: physfs.py
+Version: 0.0.2
+Summary: PhysFS.py is a python wrapper for the PhysicsFS library.
+Home-page: https://github.com/shabbywu/physfs.py
+Author: shabbywu
+Author-email: shabbywu@qq.com
+Requires-Python: >=3.7
+Provides-Extra: test
+License-File: LICENSE

physfs.py-0.0.2/README.md

@@ -0,0 +1,61 @@
+PhysFS.py
+==============
+
+![github-stars][stars-badge]
+
+|      CI              | status |
+|----------------------|--------|
+| Linux/macOS Travis   | [![Travis-CI][travis-badge]][travis-link] |
+| MSVC 2019            | [![AppVeyor][appveyor-badge]][appveyor-link] |
+| pip builds           | [![Pip Actions Status][actions-pip-badge]][actions-pip-link] |
+| [`cibuildwheel`][]   | [![Wheels Actions Status][actions-wheels-badge]][actions-wheels-link] |
+
+[gitter-badge]:            https://badges.gitter.im/pybind/Lobby.svg
+[stars-badge]:             https://img.shields.io/github/stars/shabbywu/physfs.py?style=social
+[actions-badge]:           https://github.com/shabbywu/physfs.py/workflows/Tests/badge.svg
+[actions-pip-link]:        https://github.com/shabbywu/physfs.py/actions?query=workflow%3A%22Pip
+[actions-pip-badge]:       https://github.com/shabbywu/physfs.py/workflows/Pip/badge.svg
+[actions-wheels-link]:     https://github.com/shabbywu/physfs.py/actions?query=workflow%3AWheels
+[actions-wheels-badge]:    https://github.com/shabbywu/physfs.py/workflows/Wheels/badge.svg
+[travis-link]:             https://travis-ci.org/shabbywu/physfs.py
+[travis-badge]:            https://travis-ci.org/shabbywu/physfs.py.svg?branch=master&status=passed
+[appveyor-link]:           https://ci.appveyor.com/project/shabbywu/physfs.py
+<!-- TODO: get a real badge link for appveyor -->
+[appveyor-badge]:          https://travis-ci.org/shabbywu/physfs.py.svg?branch=master&status=passed
+[`cibuildwheel`]:          https://cibuildwheel.readthedocs.io
+
+PhysFS.py is a python wrapper for the PhysicsFS library.
+
+Installation
+------------
+
+ - clone this repository
+ - `pip install ./physfs.py`
+
+Requirements
+------------
+CMake for building, and, of course, the PhysicsFS library.
+
+Features
+------------
+physfs.py provides an encapsulation of the basic interface of PhysFS, including `init`, `deinit`, `mount`, `unmount`, `ls`, `read(cat)`, `stat`.
+
+Enables python to use PhysFS at a minimum.
+
+License
+-------
+
+pybind11 is provided under a BSD-style license that can be found in the LICENSE
+file. By using, distributing, or contributing to this project, you agree to the
+terms and conditions of this license.
+
+Test call
+---------
+
+```python
+import physfs
+physfs.init()
+
+physfs.mount("./example.zip")
+physfs.ls()
+```

physfs.py-0.0.2/physfs.py.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.1
+Name: physfs.py
+Version: 0.0.2
+Summary: PhysFS.py is a python wrapper for the PhysicsFS library.
+Home-page: https://github.com/shabbywu/physfs.py
+Author: shabbywu
+Author-email: shabbywu@qq.com
+Requires-Python: >=3.7
+Provides-Extra: test
+License-File: LICENSE

physfs.py-0.0.2/physfs.py.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+libs/physfs
+physfs.py.egg-info/PKG-INFO
+physfs.py.egg-info/SOURCES.txt
+physfs.py.egg-info/dependency_links.txt
+physfs.py.egg-info/not-zip-safe
+physfs.py.egg-info/requires.txt
+physfs.py.egg-info/top_level.txt
+src/main.cpp
+src/shim.cpp
+tests/test.py

physfs.py-0.0.2/physfs.py.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

physfs.py-0.0.2/physfs.py.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

physfs.py-0.0.2/physfs.py.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[test]
+pytest

physfs.py-0.0.2/physfs.py.egg-info/top_level.txt

@@ -0,0 +1 @@
+physfs

physfs.py-0.0.2/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "pybind11>=2.10.0",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.cibuildwheel]
+test-command = "python {project}/tests/test.py"
+test-skip = "*universal2:arm64"
+
+[tool.ruff]
+extend-select = [
+  "B",   # flake8-bugbear
+  "I",   # isort
+  "PGH", # pygrep-hooks
+  "RUF", # Ruff-specific
+  "UP",  # pyupgrade
+]
+extend-ignore = [
+  "E501",   # Line too long
+]
+target-version = "py37"

physfs.py-0.0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

physfs.py-0.0.2/setup.py

@@ -0,0 +1,120 @@
+# Available at setup time due to pyproject.toml
+import platform
+import os
+from pathlib import Path
+from glob import glob
+from distutils import log
+
+# Available at setup time due to pyproject.toml
+from pybind11.setup_helpers import Pybind11Extension, build_ext
+from setuptools.command.build_clib import build_clib as _build_clib
+from setuptools import setup, Extension
+from setuptools.extension import Library
+
+__version__ = "0.0.2"
+IS_WINDOWS = platform.system() == "Windows"
+IS_MACOS = platform.system() == "Darwin"
+
+
+ext_libraries = [
+   [
+      "physfs", 
+      {
+         "sources": ["libs/physfs"],
+         "type": "cmake",
+         "cmake_args": [
+            # disable build shared library for macos and linux
+            "-DPHYSFS_BUILD_SHARED=false"
+            if not IS_WINDOWS else 
+            # disable build static library for windows(before something wrong in windows)
+            "-DPHYSFS_BUILD_STATIC=false",
+            # disable build test
+            "-DPHYSFS_BUILD_TEST=false", 
+            # disable build docs
+            "-DPHYSFS_BUILD_DOCS=false", 
+            # set -fPIC
+            "-DCMAKE_POSITION_INDEPENDENT_CODE=ON",
+         ],
+         "copy_objects": [] if not IS_WINDOWS else ["physfs.dll"]
+      }
+   ]
+]
+
+
+extra_link_args = []
+if IS_MACOS:
+   extra_link_args = ["-framework", "IOKit", "-framework", "Foundation"]
+
+
+ext_modules = [
+    Pybind11Extension("physfs",
+        ["src/main.cpp", "src/shim.cpp"],
+        # Example: passing in the version to the compiled code
+        define_macros = [('VERSION_INFO', __version__)],
+        include_dirs=["libs/physfs/src"],
+        extra_link_args=extra_link_args,
+    ),
+]
+
+
+class build_clib(_build_clib):
+   def build_libraries(self, libraries):
+      cwd = Path().absolute()
+      other_libraries = []
+      for (lib_name, build_info) in libraries:
+         if build_info.get("type") != "cmake":
+            libraries.append((lib_name, build_info))
+            continue
+
+         log.info("building '%s' library", lib_name)
+         src = Path(build_info["sources"][0]).absolute()
+         build_temp = (Path(self.build_temp) / lib_name).absolute()
+         build_temp.mkdir(parents=True, exist_ok=True)
+         config = 'Debug' if self.debug else 'Release'
+         build_dest = build_temp / config if IS_WINDOWS else build_temp
+
+         build_ext = self.get_finalized_command('build_ext')
+         build_lib = Path(build_ext.build_lib).absolute()
+         cmake_args = [
+            '-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=' + str(build_temp),
+            '-DCMAKE_BUILD_TYPE=' + config,
+            *build_info.get("cmake_args", [])
+         ]
+         build_args = [
+            '--config', config,
+            "-v"
+         ]
+         os.chdir(str(build_temp))
+         self.spawn(['cmake', str(src)] + cmake_args)
+         if not self.dry_run:
+            self.spawn(['cmake', '--build', '.'] + build_args)
+            # extend library_dirs
+            for ext in build_ext.extensions:
+               ext.library_dirs.append(str(build_dest))
+            # copy objects to dest
+            build_lib.mkdir(parents=True, exist_ok=True)
+            copy_objects = build_info.get("copy_objects")
+            if copy_objects:
+               for obj in copy_objects:
+                  self.copy_file(str(build_dest / obj), str(build_lib / obj))
+         os.chdir(str(cwd))
+      return super().build_libraries(other_libraries)
+
+
+setup(
+    name="physfs.py",
+    version=__version__,
+    author="shabbywu",
+    author_email="shabbywu@qq.com",
+    url="https://github.com/shabbywu/physfs.py",
+    description="PhysFS.py is a python wrapper for the PhysicsFS library.",
+    long_description="",
+    ext_modules=ext_modules,
+    libraries=ext_libraries,
+    extras_require={"test": "pytest"},
+    # Currently, build_ext only provides an optional "highest supported C++
+    # level" feature, but in the future it may provide more features.
+    cmdclass={"build_ext": build_ext, "build_clib": build_clib},
+    zip_safe=False,
+    python_requires=">=3.7",
+)

physfs.py-0.0.2/src/main.cpp

@@ -0,0 +1,20 @@
+#include <pybind11/pybind11.h>
+#include "shim.h"
+
+#define STRINGIFY(x) #x
+#define MACRO_STRINGIFY(x) STRINGIFY(x)
+
+
+namespace py = pybind11;
+
+
+PYBIND11_MODULE(physfs, m) {
+    register_physfs(m);
+#ifdef VERSION_INFO
+    m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
+#else
+    m.attr("__version__") = "dev";
+#endif
+
+m.attr("__author__") = "shabbywu<shabbywu@qq.com>";
+}

physfs.py-0.0.2/src/shim.cpp

@@ -0,0 +1,222 @@
+#include "shim.h"
+
+
+namespace py = pybind11;
+
+
+template<typename ... Args>
+std::string string_format( const std::string& format, Args ... args )
+{
+    int size_s = std::snprintf( nullptr, 0, format.c_str(), args ... ) + 1; // Extra space for '\0'
+    if( size_s <= 0 ){ throw std::runtime_error( "Error during formatting." ); }
+    auto size = static_cast<size_t>( size_s );
+    std::unique_ptr<char[]> buf( new char[ size ] );
+    std::snprintf( buf.get(), size, format.c_str(), args ... );
+    return std::string( buf.get(), buf.get() + size - 1 ); // We don't want the '\0' inside
+}
+
+
+void physfs_init() {
+    if (!PHYSFS_init(NULL)) {
+        throw std::runtime_error(string_format("Failure. Reason: [%s]", PHYSFS_getLastError()));
+    }
+}
+
+
+void physfs_deinit() {
+    if (!PHYSFS_isInit()) {
+        throw std::runtime_error("PHYSFS is not initialized, please call init() first");
+    }
+
+    if (!PHYSFS_deinit()) {
+        throw std::runtime_error(string_format("Failure. Reason: [%s]", PHYSFS_getLastError()));
+    }
+}
+
+
+void physfs_mount(std::string source, std::string mountPoint = "/", py::bool_ appendToPath = py::bool_(0)) {
+    if (!PHYSFS_isInit()) {
+        throw std::runtime_error("PHYSFS is not initialized, please call init() first");
+    }
+
+    if (!PHYSFS_mount(source.c_str(), mountPoint.c_str(), appendToPath)) {
+        throw std::runtime_error(string_format("Failure. Reason: [%s]", PHYSFS_getLastError()));
+    }
+}
+
+
+void physfs_unmount(std::string oldSource) {
+    if (!PHYSFS_isInit()) {
+        throw std::runtime_error("PHYSFS is not initialized, please call init() first");
+    }
+
+    if (!PHYSFS_unmount(oldSource.c_str())) {
+        throw std::runtime_error(string_format("Failure. Reason: [%s]", PHYSFS_getLastError()));
+    }
+}
+
+
+py::list enumerate_fs(std::string dir) {
+    if (!PHYSFS_isInit()) {
+        throw std::runtime_error("PHYSFS is not initialized, please call init() first");
+    }
+
+    char **rc;
+    rc = PHYSFS_enumerateFiles(dir.c_str());
+
+    py::list result;
+    char **i;
+    for (i = rc; *i != NULL; i++) {
+        result.append(std::string(*i));
+    }
+    return result;
+}
+
+PHYSFS_Stat physfs_stat(std::string file) {
+    if (!PHYSFS_isInit()) {
+        throw std::runtime_error("PHYSFS is not initialized, please call init() first");
+    }
+
+    PHYSFS_Stat stat;
+
+    if(!PHYSFS_stat(file.c_str(), &stat))
+    {
+        throw std::runtime_error(string_format("failed to stat. Reason [%s]", PHYSFS_getLastError()));
+    }
+    return stat;
+}
+
+py::bytes physfs_cat(std::string file) {
+    if (!PHYSFS_isInit()) {
+        throw std::runtime_error("PHYSFS is not initialized, please call init() first");
+    }
+
+    PHYSFS_File *f;
+    f = PHYSFS_openRead(file.c_str());
+    if (f == NULL) {
+        throw std::runtime_error(string_format("failed to open. Reason: [%s]", PHYSFS_getLastError()));
+    }
+
+    std::stringstream output;
+    while (1)
+    {
+        char buffer[1024];
+        PHYSFS_sint64 rc;
+        PHYSFS_sint64 i;
+        rc = PHYSFS_readBytes(f, buffer, sizeof (buffer));
+        if (rc == -1 ) {
+            PHYSFS_close(f);
+            throw std::runtime_error(string_format("Error condition in reading. Reason: [%s]", PHYSFS_getLastError()));
+        }
+
+        output.write(buffer, rc);
+        if (rc < sizeof (buffer))
+        {
+            if (!PHYSFS_eof(f))
+            {
+                PHYSFS_close(f);
+                throw std::runtime_error(string_format("Error condition in reading. Reason: [%s]", PHYSFS_getLastError()));
+            }
+            PHYSFS_close(f);
+            break;
+        }
+    }
+    return py::bytes(output.str());
+}
+
+
+void register_physfs(py::module_ &m) {
+    m.doc() = R"pbdoc(
+        physfs - PhysicsFS is a library to provide abstract access to various archives.
+        -----------------------
+
+        .. currentmodule:: physfs
+
+        .. autosummary::
+           :toctree: _generate
+
+           init
+    )pbdoc";
+
+    m.def("init", &physfs_init, R"pbdoc(
+        Initialize the PhysicsFS library.
+
+    * This must be called before any other PhysicsFS function.
+    *
+    * This should be called prior to any attempts to change your process's
+    *  current working directory.
+
+    )pbdoc");
+
+    m.def("deinit", &physfs_deinit, R"pbdoc(
+        Deinitialize the PhysicsFS library.
+
+    * This closes any files opened via PhysicsFS, blanks the search/write paths,
+    *  frees memory, and invalidates all of your file handles.
+    *
+    * Note that this call can FAIL if there's a file open for writing that
+    *  refuses to close (for example, the underlying operating system was
+    *  buffering writes to network filesystem, and the fileserver has crashed,
+    *  or a hard drive has failed, etc). It is usually best to close all write
+    *  handles yourself before calling this function, so that you can gracefully
+    *  handle a specific failure.
+    *
+    * Once successfully deinitialized, PHYSFS_init() can be called again to
+    *  restart the subsystem. All default API states are restored at this
+    *  point, with the exception of any custom allocator you might have
+    *  specified, which survives between initializations.
+
+    )pbdoc");
+
+    m.def("mount", &physfs_mount, R"pbdoc(
+        Add an archive or directory to the search path.
+
+    * \param source directory or archive to add to the path, in
+    *                   platform-dependent notation.
+    * \param mountPoint Location in the interpolated tree that this archive
+    *                   will be "mounted", in platform-independent notation.
+    *                   NULL or "" is equivalent to "/".
+    * \param appendToPath nonzero to append to search path, zero to prepend.
+    )pbdoc", py::arg("source").none(false), py::arg("mountPoint") = "/", py::arg("appendToPath") = py::bool_(0));
+
+    m.def("unmount", &physfs_unmount, R"pbdoc(
+        Remove a directory or archive from the search path.
+
+    * This must be a (case-sensitive) match to a dir or archive already in the
+    *  search path, specified in platform-dependent notation.
+    *
+    * This call will fail (and fail to remove from the path) if the element still
+    *  has files open in it.
+    * 
+    * \param oldSource dir/archive to remove.
+
+    )pbdoc", py::arg("oldSource").none(false));
+
+    m.def("ls", &enumerate_fs, R"pbdoc(
+        Get a file listing of a search path's directory.
+    )pbdoc", py::arg("dir") = "/");
+
+    m.def("stat", &physfs_stat, R"pbdoc(
+        Get various information about a directory or a file.
+    )pbdoc", py::arg("file").none(false));
+
+    m.def("cat", &physfs_cat, R"pbdoc(
+        Read bytes from a PhysicsFS filehandle
+    )pbdoc", py::arg("file").none(false));
+
+    m.def("read", &physfs_cat, R"pbdoc(
+        Read bytes from a PhysicsFS filehandle, read is alias of cat.
+    )pbdoc", py::arg("file").none(false));
+
+    py::class_<PHYSFS_Stat>(m, "PHYSFS_Stat")
+    .def_readwrite("filetype", &PHYSFS_Stat::filetype)
+    .def_readwrite("filesize", &PHYSFS_Stat::filesize)
+    ;
+
+    py::enum_<PHYSFS_FileType>(m, "PHYSFS_FileType")
+        .value("PHYSFS_FILETYPE_REGULAR", PHYSFS_FileType::PHYSFS_FILETYPE_REGULAR)
+        .value("PHYSFS_FILETYPE_DIRECTORY", PHYSFS_FileType::PHYSFS_FILETYPE_DIRECTORY)
+        .value("PHYSFS_FILETYPE_SYMLINK", PHYSFS_FileType::PHYSFS_FILETYPE_SYMLINK)
+        .value("PHYSFS_FILETYPE_OTHER", PHYSFS_FileType::PHYSFS_FILETYPE_OTHER);
+
+}

physfs.py-0.0.2/tests/test.py

@@ -0,0 +1,24 @@
+from pathlib import Path
+import physfs
+
+rootdir = Path(__file__).parent
+assert physfs.__version__ == '0.0.2'
+
+physfs.init()
+assert physfs.ls("/") == []
+
+physfs.mount(str(rootdir / "./example.zip"))
+assert physfs.ls("/") == ["example"]
+assert physfs.cat("example/flag") == b"OqP$IwK7eiZyTWk4Xi3jYECi^IXLdZw1u@H5wOo4\n"
+
+physfs.unmount(str(rootdir / "./example.zip"))
+assert physfs.ls("/") == []
+
+physfs.deinit()
+
+E = None
+try:
+    physfs.ls()
+except RuntimeError as e:
+    E = e
+assert E is not None