filesystem.h
Go to the documentation of this file.
1 // Copyright (c) 2021 The Pybind Development Team.
2 // All rights reserved. Use of this source code is governed by a
3 // BSD-style license that can be found in the LICENSE file.
4 
5 #pragma once
6 
7 #include "../pybind11.h"
8 #include "../detail/common.h"
9 #include "../detail/descr.h"
10 #include "../cast.h"
11 #include "../pytypes.h"
12 
13 #include <string>
14 
15 #ifdef __has_include
16 # if defined(PYBIND11_CPP17)
17 # if __has_include(<filesystem>)
18 # include <filesystem>
19 # define PYBIND11_HAS_FILESYSTEM 1
20 # elif __has_include(<experimental/filesystem>)
21 # include <experimental/filesystem>
22 # define PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM 1
23 # endif
24 # endif
25 #endif
26 
27 #if !defined(PYBIND11_HAS_FILESYSTEM) && !defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM) \
28  && !defined(PYBIND11_HAS_FILESYSTEM_IS_OPTIONAL)
29 # error \
30  "Neither #include <filesystem> nor #include <experimental/filesystem is available. (Use -DPYBIND11_HAS_FILESYSTEM_IS_OPTIONAL to ignore.)"
31 #endif
32 
35 
36 #if defined(PYBIND11_HAS_FILESYSTEM) || defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM)
37 template <typename T>
38 struct path_caster {
39 
40 private:
41  static PyObject *unicode_from_fs_native(const std::string &w) {
42 # if !defined(PYPY_VERSION)
43  return PyUnicode_DecodeFSDefaultAndSize(w.c_str(), ssize_t(w.size()));
44 # else
45  // PyPy mistakenly declares the first parameter as non-const.
46  return PyUnicode_DecodeFSDefaultAndSize(const_cast<char *>(w.c_str()), ssize_t(w.size()));
47 # endif
48  }
49 
50  static PyObject *unicode_from_fs_native(const std::wstring &w) {
51  return PyUnicode_FromWideChar(w.c_str(), ssize_t(w.size()));
52  }
53 
54 public:
55  static handle cast(const T &path, return_value_policy, handle) {
56  if (auto py_str = unicode_from_fs_native(path.native())) {
57  return module_::import("pathlib")
58  .attr("Path")(reinterpret_steal<object>(py_str))
59  .release();
60  }
61  return nullptr;
62  }
63 
64  bool load(handle handle, bool) {
65  // PyUnicode_FSConverter and PyUnicode_FSDecoder normally take care of
66  // calling PyOS_FSPath themselves, but that's broken on PyPy (PyPy
67  // issue #3168) so we do it ourselves instead.
68  PyObject *buf = PyOS_FSPath(handle.ptr());
69  if (!buf) {
70  PyErr_Clear();
71  return false;
72  }
73  PyObject *native = nullptr;
74  if constexpr (std::is_same_v<typename T::value_type, char>) {
75  if (PyUnicode_FSConverter(buf, &native) != 0) {
76  if (auto *c_str = PyBytes_AsString(native)) {
77  // AsString returns a pointer to the internal buffer, which
78  // must not be free'd.
79  value = c_str;
80  }
81  }
82  } else if constexpr (std::is_same_v<typename T::value_type, wchar_t>) {
83  if (PyUnicode_FSDecoder(buf, &native) != 0) {
84  if (auto *c_str = PyUnicode_AsWideCharString(native, nullptr)) {
85  // AsWideCharString returns a new string that must be free'd.
86  value = c_str; // Copies the string.
87  PyMem_Free(c_str);
88  }
89  }
90  }
91  Py_XDECREF(native);
92  Py_DECREF(buf);
93  if (PyErr_Occurred()) {
94  PyErr_Clear();
95  return false;
96  }
97  return true;
98  }
99 
100  PYBIND11_TYPE_CASTER(T, const_name("os.PathLike"));
101 };
102 
103 #endif // PYBIND11_HAS_FILESYSTEM || defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM)
104 
105 #if defined(PYBIND11_HAS_FILESYSTEM)
106 template <>
107 struct type_caster<std::filesystem::path> : public path_caster<std::filesystem::path> {};
108 #elif defined(PYBIND11_HAS_EXPERIMENTAL_FILESYSTEM)
109 template <>
111  : public path_caster<std::experimental::filesystem::path> {};
112 #endif
113 
w
RowVector3d w
Definition: Matrix_resize_int.cpp:3
module_::import
static module_ import(const char *name)
Import and return a module or throws error_already_set.
Definition: pybind11.h:1278
ssize_t
Py_ssize_t ssize_t
Definition: wrap/pybind11/include/pybind11/detail/common.h:489
const_name
constexpr descr< N - 1 > const_name(char const (&text)[N])
Definition: descr.h:60
return_value_policy
return_value_policy
Approach used to cast a previously unknown C++ instance into a Python object.
Definition: wrap/pybind11/include/pybind11/detail/common.h:499
PYBIND11_NAMESPACE_END
#define PYBIND11_NAMESPACE_END(name)
Definition: wrap/pybind11/include/pybind11/detail/common.h:80
detail
Definition: testSerializationNonlinear.cpp:70
PYBIND11_NAMESPACE_BEGIN
#define PYBIND11_NAMESPACE_BEGIN(name)
Definition: wrap/pybind11/include/pybind11/detail/common.h:76
handle
Definition: pytypes.h:226
type_caster
Definition: cast.h:38
conf.release
release
Definition: gtsam/3rdparty/GeographicLib/python/doc/conf.py:69
PYBIND11_NAMESPACE
Definition: test_custom_type_casters.cpp:24
Eigen::Triplet
A small structure to hold a non zero as a triplet (i,j,value).
Definition: SparseUtil.h:162
matlab_wrap.path
path
Definition: matlab_wrap.py:66
PYBIND11_TYPE_CASTER
#define PYBIND11_TYPE_CASTER(type, py_name)
Definition: cast.h:87
handle::ptr
PyObject * ptr() const
Return the underlying PyObject * pointer.
Definition: pytypes.h:250
std
Definition: BFloat16.h:88
c_str
const char * c_str(Args &&...args)
Definition: internals.h:684
test_callbacks.value
value
Definition: test_callbacks.py:160
Eigen::internal::cast
EIGEN_DEVICE_FUNC NewType cast(const OldType &x)
Definition: Eigen/src/Core/MathFunctions.h:460


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:32:32