Skip to content
This repository has been archived by the owner on Dec 31, 2023. It is now read-only.

add a new action: getMediaDirPath #379

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1759,6 +1759,32 @@ corresponding to when the API was available for use.
```
</details>

#### `getMediaDirPath`

* Gets the full path to the `collection.media` folder of the currently opened profile.

<details>
<summary><i>Sample request:</i></summary>

```json
{
"action": "getMediaDirPath",
"version": 6
}
```
</details>

<details>
<summary><i>Sample result:</i></summary>

```json
{
"result": "/home/user/.local/share/Anki2/Main/collection.media",
"error": null
}
```
</details>

#### `deleteMediaFile`

* Deletes the specified file inside the media folder.
Expand Down
3 changes: 3 additions & 0 deletions plugin/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,9 @@ def deleteMediaFile(self, filename):
except AttributeError:
self.media().trash_files([filename])

@util.api()
def getMediaDirPath(self):
return os.path.abspath(self.media().dir())

@util.api()
def addNote(self, note):
Expand Down
5 changes: 5 additions & 0 deletions tests/test_media.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import base64
import os.path

from conftest import ac

Expand Down Expand Up @@ -49,3 +50,7 @@ def test_deleteMediaFile(session_with_profile_loaded):
ac.deleteMediaFile(filename=filename_1)
assert ac.retrieveMediaFile(filename=filename_1) is False
assert ac.getMediaFilesNames(pattern="_tes*.txt") == [filename_2]


def test_getMediaDirPath(session_with_profile_loaded):
assert os.path.isdir(ac.getMediaDirPath())