Ruff format docstring Python code (#15792)

Signed-off-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
This commit is contained in:
Glenn Jocher 2024-08-25 01:08:07 +08:00 committed by GitHub
parent c1882a4327
commit d27664216b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
63 changed files with 370 additions and 374 deletions

View file

@ -75,7 +75,7 @@ def delete_dsstore(path, files_to_delete=(".DS_Store", "__MACOSX")):
```python
from ultralytics.utils.downloads import delete_dsstore
delete_dsstore('path/to/dir')
delete_dsstore("path/to/dir")
```
Note:
@ -107,7 +107,7 @@ def zip_directory(directory, compress=True, exclude=(".DS_Store", "__MACOSX"), p
```python
from ultralytics.utils.downloads import zip_directory
file = zip_directory('path/to/dir')
file = zip_directory("path/to/dir")
```
"""
from zipfile import ZIP_DEFLATED, ZIP_STORED, ZipFile
@ -153,7 +153,7 @@ def unzip_file(file, path=None, exclude=(".DS_Store", "__MACOSX"), exist_ok=Fals
```python
from ultralytics.utils.downloads import unzip_file
dir = unzip_file('path/to/file.zip')
dir = unzip_file("path/to/file.zip")
```
"""
from zipfile import BadZipFile, ZipFile, is_zipfile
@ -392,7 +392,7 @@ def get_github_assets(repo="ultralytics/assets", version="latest", retry=False):
Example:
```python
tag, assets = get_github_assets(repo='ultralytics/assets', version='latest')
tag, assets = get_github_assets(repo="ultralytics/assets", version="latest")
```
"""
@ -425,7 +425,7 @@ def attempt_download_asset(file, repo="ultralytics/assets", release="v8.2.0", **
Example:
```python
file_path = attempt_download_asset('yolov8n.pt', repo='ultralytics/assets', release='latest')
file_path = attempt_download_asset("yolov8n.pt", repo="ultralytics/assets", release="latest")
```
"""
from ultralytics.utils import SETTINGS # scoped for circular import
@ -480,7 +480,7 @@ def download(url, dir=Path.cwd(), unzip=True, delete=False, curl=False, threads=
Example:
```python
download('https://ultralytics.com/assets/example.zip', dir='path/to/dir', unzip=True)
download("https://ultralytics.com/assets/example.zip", dir="path/to/dir", unzip=True)
```
"""
dir = Path(dir)