Skip to content

Commit 0c941bc

Browse files
author
“bingtao”
committed
feat: 新增 OSSUtil 云存储驱动
- 新增 OSSUtilDrive 驱动,基于阿里云官方 ossutil 命令行工具 - 更新 API 文档和变更日志 - 增加 ossutil 依赖到 pyproject.toml - 版本号升级至 2.0.43 - 添加详细的 README 文档和使用示例 此功能提供了完整的阿里云 OSS 对象存储操作功能,包括文件上传下载、目录管理、搜索和分享等。
1 parent da62577 commit 0c941bc

13 files changed

Lines changed: 1889 additions & 220 deletions

File tree

.idea/dictionaries/project.xml

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

LICENSE

Lines changed: 21 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,21 @@
1-
Apache License
2-
Version 2.0, January 2004
3-
http://www.apache.org/licenses/
4-
5-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6-
7-
1. Definitions.
8-
9-
"License" shall mean the terms and conditions for use, reproduction,
10-
and distribution as defined by Sections 1 through 9 of this document.
11-
12-
"Licensor" shall mean the copyright owner or entity authorized by
13-
the copyright owner that is granting the License.
14-
15-
"Legal Entity" shall mean the union of the acting entity and all
16-
other entities that control, are controlled by, or are under common
17-
control with that entity. For the purposes of this definition,
18-
"control" means (i) the power, direct or indirect, to cause the
19-
direction or management of such entity, whether by contract or
20-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21-
outstanding shares, or (iii) beneficial ownership of such entity.
22-
23-
"You" (or "Your") shall mean an individual or Legal Entity
24-
exercising permissions granted by this License.
25-
26-
"Source" form shall mean the preferred form for making modifications,
27-
including but not limited to software source code, documentation
28-
source, and configuration files.
29-
30-
"Object" form shall mean any form resulting from mechanical
31-
transformation or translation of a Source form, including but
32-
not limited to compiled object code, generated documentation,
33-
and conversions to other media types.
34-
35-
"Work" shall mean the work of authorship, whether in Source or
36-
Object form, made available under the License, as indicated by a
37-
copyright notice that is included in or attached to the work
38-
(an example is provided in the Appendix below).
39-
40-
"Derivative Works" shall mean any work, whether in Source or Object
41-
form, that is based on (or derived from) the Work and for which the
42-
editorial revisions, annotations, elaborations, or other modifications
43-
represent, as a whole, an original work of authorship. For the purposes
44-
of this License, Derivative Works shall not include works that remain
45-
separable from, or merely link (or bind by name) to the interfaces of,
46-
the Work and Derivative Works thereof.
47-
48-
"Contribution" shall mean any work of authorship, including
49-
the original version of the Work and any modifications or additions
50-
to that Work or Derivative Works thereof, that is intentionally
51-
submitted to Licensor for inclusion in the Work by the copyright owner
52-
or by an individual or Legal Entity authorized to submit on behalf of
53-
the copyright owner. For the purposes of this definition, "submitted"
54-
means any form of electronic, verbal, or written communication sent
55-
to the Licensor or its representatives, including but not limited to
56-
communication on electronic mailing lists, source code control systems,
57-
and issue tracking systems that are managed by, or on behalf of, the
58-
Licensor for the purpose of discussing and improving the Work, but
59-
excluding communication that is conspicuously marked or otherwise
60-
designated in writing by the copyright owner as "Not a Contribution."
61-
62-
"Contributor" shall mean Licensor and any individual or Legal Entity
63-
on behalf of whom a Contribution has been received by Licensor and
64-
subsequently incorporated within the Work.
65-
66-
2. Grant of Copyright License. Subject to the terms and conditions of
67-
this License, each Contributor hereby grants to You a perpetual,
68-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69-
copyright license to reproduce, prepare Derivative Works of,
70-
publicly display, publicly perform, sublicense, and distribute the
71-
Work and such Derivative Works in Source or Object form.
72-
73-
3. Grant of Patent License. Subject to the terms and conditions of
74-
this License, each Contributor hereby grants to You a perpetual,
75-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76-
(except as stated in this section) patent license to make, have made,
77-
use, offer to sell, sell, import, and otherwise transfer the Work,
78-
where such license applies only to those patent claims licensable
79-
by such Contributor that are necessarily infringed by their
80-
Contribution(s) alone or by combination of their Contribution(s)
81-
with the Work to which such Contribution(s) was submitted. If You
82-
institute patent litigation against any entity (including a
83-
cross-claim or counterclaim in a lawsuit) alleging that the Work
84-
or a Contribution incorporated within the Work constitutes direct
85-
or contributory patent infringement, then any patent licenses
86-
granted to You under this License for that Work shall terminate
87-
as of the date such litigation is filed.
88-
89-
4. Redistribution. You may reproduce and distribute copies of the
90-
Work or Derivative Works thereof in any medium, with or without
91-
modifications, and in Source or Object form, provided that You
92-
meet the following conditions:
93-
94-
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
96-
97-
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
99-
100-
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, patent, trademark, and
102-
attribution notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
105-
106-
(d) If the Work includes a "NOTICE" text file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE text file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
122-
123-
You may add Your own copyright statement to Your modifications and
124-
may provide additional or different license terms and conditions
125-
for use, reproduction, or distribution of Your modifications, or
126-
for any such Derivative Works as a whole, provided Your use,
127-
reproduction, and distribution of the Work otherwise complies with
128-
the conditions stated in this License.
129-
130-
5. Submission of Contributions. Unless You explicitly state otherwise,
131-
any Contribution intentionally submitted for inclusion in the Work
132-
by You to the Licensor shall be under the terms and conditions of
133-
this License, without any additional terms or conditions.
134-
Notwithstanding the above, nothing herein shall supersede or modify
135-
the terms of any separate license agreement you may have executed
136-
with Licensor regarding such Contributions.
137-
138-
6. Trademarks. This License does not grant permission to use the trade
139-
names, trademarks, service marks, or product names of the Licensor,
140-
except as required for reasonable and customary use in describing the
141-
origin of the Work and reproducing the content of the NOTICE file.
142-
143-
7. Disclaimer of Warranty. Unless required by applicable law or
144-
agreed to in writing, Licensor provides the Work (and each
145-
Contributor provides its Contributions) on an "AS IS" BASIS,
146-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147-
implied, including, without limitation, any warranties or conditions
148-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149-
PARTICULAR PURPOSE. You are solely responsible for determining the
150-
appropriateness of using or redistributing the Work and assume any
151-
risks associated with Your exercise of permissions under this License.
152-
153-
8. Limitation of Liability. In no event and under no legal theory,
154-
whether in tort (including negligence), contract, or otherwise,
155-
unless required by applicable law (such as deliberate and grossly
156-
negligent acts) or agreed to in writing, shall any Contributor be
157-
liable to You for damages, including any direct, indirect, special,
158-
incidental, or consequential damages of any character arising as a
159-
result of this License or out of the use or inability to use the
160-
Work (including but not limited to damages for loss of goodwill,
161-
work stoppage, computer failure or malfunction, or any and all
162-
other commercial damages or losses), even if such Contributor
163-
has been advised of the possibility of such damages.
164-
165-
9. Accepting Warranty or Additional Liability. While redistributing
166-
the Work or Derivative Works thereof, You may choose to offer,
167-
and charge a fee for, acceptance of support, warranty, indemnity,
168-
or other liability obligations and/or rights consistent with this
169-
License. However, in accepting such obligations, You may act only
170-
on Your own behalf and on Your sole responsibility, not on behalf
171-
of any other Contributor, and only if You agree to indemnify,
172-
defend, and hold each Contributor harmless for any liability
173-
incurred by, or claims asserted against, such Contributor by reason
174-
of your accepting any such warranty or additional liability.
175-
176-
END OF TERMS AND CONDITIONS
177-
178-
APPENDIX: How to apply the Apache License to your work.
179-
180-
To apply the Apache License to your work, attach the following
181-
boilerplate notice, with the fields enclosed by brackets "[]"
182-
replaced with your own identifying information. (Don't include
183-
the brackets!) The text should be enclosed in the appropriate
184-
comment syntax for the file format. We also recommend that a
185-
file or class name and description of purpose be included on the
186-
same "printed page" as the copyright notice for easier
187-
identification within third-party archives.
188-
189-
Copyright [2023] [niuliangtao]
190-
191-
Licensed under the Apache License, Version 2.0 (the "License");
192-
you may not use this file except in compliance with the License.
193-
You may obtain a copy of the License at
194-
195-
http://www.apache.org/licenses/LICENSE-2.0
196-
197-
Unless required by applicable law or agreed to in writing, software
198-
distributed under the License is distributed on an "AS IS" BASIS,
199-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200-
See the License for the specific language governing permissions and
201-
limitations under the License.
1+
MIT License
2+
3+
Copyright (c) 2025 farfarfun
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

docs/API.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -205,21 +205,22 @@ print(f"是否为目录: {file.is_dir}")
205205
7. **BaiDuDrive** - 百度网盘
206206
8. **AlipanDrive** - 阿里云盘(Aligo版本)
207207
9. **AliopenDrive** - 阿里云盘(Open API版本)
208-
10. **OSSDrive** - 阿里云OSS
208+
10. **OSSDrive** - 阿里云OSS(Python SDK版本)
209+
11. **OSSUtilDrive** - 阿里云OSS(ossutil命令行工具版本)
209210

210211
### 🔧 通用协议和工具
211-
11. **WebDAVDrive** - WebDAV协议
212-
12. **OSDrive** - 本地文件系统
213-
13. **PCloudDrive** - PCloud云存储
214-
14. **MediaFireDrive** - MediaFire文件分享
215-
15. **LanzouDrive** - 蓝奏云
212+
12. **WebDAVDrive** - WebDAV协议
213+
13. **OSDrive** - 本地文件系统
214+
14. **PCloudDrive** - PCloud云存储
215+
15. **MediaFireDrive** - MediaFire文件分享
216+
16. **LanzouDrive** - 蓝奏云
216217

217218
### 🔬 学术和专业服务
218-
16. **ZenodoDrive** - Zenodo学术数据存储
219-
17. **TianChiDrive** - 天池数据科学平台
220-
18. **TSingHuaDrive** - 清华云盘
221-
19. **OpenXLabDrive** - OpenXLab AI平台
222-
20. **WSSDrive** - 文叔叔临时存储
219+
17. **ZenodoDrive** - Zenodo学术数据存储
220+
18. **TianChiDrive** - 天池数据科学平台
221+
19. **TSingHuaDrive** - 清华云盘
222+
20. **OpenXLabDrive** - OpenXLab AI平台
223+
21. **WSSDrive** - 文叔叔临时存储
223224

224225
## 异常处理
225226

docs/CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22

33
本文档记录了 FunDrive 项目的所有重要变更、优化和修复工作。
44

5+
## [2025-09-22] - 新增 OSSUtil 云存储驱动
6+
7+
### 🎯 新增功能
8+
-**新增 OSSUtilDrive 驱动** - 基于阿里云官方 ossutil 命令行工具的云存储驱动
9+
- 支持完整的阿里云 OSS 对象存储操作功能
10+
- 自动下载和配置 ossutil 工具,支持多平台(Windows、macOS、Linux)
11+
- 实现所有核心方法:登录、文件操作、目录操作、上传下载等
12+
- 支持高级功能:文件搜索、分享、配额查询、文件管理等
13+
- 提供完整的示例代码和详细文档
14+
15+
### 🔧 技术特性
16+
- **自动化工具管理**: 自动检测平台和架构,下载对应的 ossutil 二进制文件
17+
- **配置管理**: 集成 funsecret 进行安全的认证信息管理
18+
- **错误处理**: 完善的异常处理和中文日志记录
19+
- **类型安全**: 完整的类型注解和接口规范
20+
- **测试覆盖**: 提供基本功能、高级功能、演示和交互式测试模式
21+
22+
### 📚 文档更新
23+
- 创建完整的 ossutil 驱动使用文档
24+
- 更新 API 文档包含新驱动信息
25+
- 提供丰富的使用示例和配置说明
26+
27+
### 🎉 项目状态
28+
- 项目现在支持 21 个云存储平台
29+
- 阿里云 OSS 现在有两个驱动选择:OSSDrive(Python SDK)和 OSSUtilDrive(命令行工具)
30+
531
## [2024-12-11] - 项目全面优化和标准化
632

733
### 🎯 总体目标

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "fundrive"
3-
version = "2.0.42"
3+
version = "2.0.43"
44
description = "fundrive"
55
readme = "README.md"
66
requires-python = ">=3.8"
@@ -39,6 +39,7 @@ amazon = [ "boto3>=1.34.0",]
3939
tsinghua = [ "requests>=2.32.4",]
4040
github = [ "requests>=2.32.4", "orjson>=3.10.10",]
4141
gitee = [ "requests>=2.32.4", "orjson>=3.10.10",]
42+
ossutil = [ "funinstall>=1.0.54",]
4243

4344
[project.urls]
4445
Organization = "https://github.com/farfarfun"

src/fundrive/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@
5353
from .drives import (
5454
get_drive,
5555
list_available_drives,
56-
get_drive_info,
5756
AVAILABLE_DRIVES,
5857
)
5958

@@ -99,7 +98,6 @@
9998
# 驱动管理
10099
"get_drive",
101100
"list_available_drives",
102-
"get_drive_info",
103101
"AVAILABLE_DRIVES",
104102
]
105103

src/fundrive/drives/__init__.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@
5454
except ImportError:
5555
OssDrive = None
5656

57+
try:
58+
from .ossutil import OSSUtilDrive
59+
except ImportError:
60+
OSSUtilDrive = None
61+
5762
# 🔧 通用协议和工具 - 兼容性强
5863
try:
5964
from .webdav import WebDAVDrive
@@ -76,9 +81,7 @@
7681
LanzouDrive = None
7782

7883
try:
79-
from .os import OSDrive
80-
81-
LocalDrive = OSDrive # 为了向后兼容保留LocalDrive别名
84+
from .os import OSDrive, LocalDrive
8285
except ImportError:
8386
OSDrive = None
8487
LocalDrive = None
@@ -125,6 +128,7 @@
125128
"alipan": AliPanDrive,
126129
"alipan_open": AliPanOpenDrive,
127130
"oss": OssDrive,
131+
"ossutil": OSSUtilDrive,
128132
# 🔧 通用协议和工具
129133
"webdav": WebDAVDrive,
130134
"pcloud": PCloudDrive,
@@ -207,6 +211,7 @@ def list_available_drives():
207211
"AliPanDrive",
208212
"AliPanOpenDrive",
209213
"OssDrive",
214+
"OSSUtilDrive",
210215
"WebDAVDrive",
211216
"PCloudDrive",
212217
"MediaFireDrive",

src/fundrive/drives/os/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
from .drive import OSDrive
1+
from .drive import OSDrive, LocalDrive
22

3-
__all__ = ["OSDrive"]
3+
__all__ = ["OSDrive", "LocalDrive"]

src/fundrive/drives/os/drive.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,7 @@ def get_dir_list(self, path, *args, **kwargs) -> List[Dict[str, Any]]:
8888
if os.path.isdir(file_path):
8989
result.append({"path": file_path})
9090
return result
91+
92+
93+
class LocalDrive(OSDrive):
94+
pass

0 commit comments

Comments
 (0)