https://github.com/tjdevries/apyrori.nvim
Auto imports for Python based on your current project
https://github.com/tjdevries/apyrori.nvim
Last synced: 8 months ago
JSON representation
Auto imports for Python based on your current project
- Host: GitHub
- URL: https://github.com/tjdevries/apyrori.nvim
- Owner: tjdevries
- License: mit
- Created: 2020-03-23T13:51:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T01:54:51.000Z (over 5 years ago)
- Last Synced: 2025-04-09T05:51:12.643Z (about 1 year ago)
- Language: Lua
- Size: 51.8 KB
- Stars: 22
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# apyrori.nvim
Auto imports for Python based on your current project. The name is a pun on _a priori_. It's not a great pun, but it's a pun nonetheless.
## How it works
It's pretty simple and it's pretty dumb, and that's why it works so great.
When you're working on a large project, you've probably imported the thing you want to import somewhere before.
This plugin simply looks at all the places you've imported the word under your cursor, picks the most likely (A.K.A. most frequent) import
and adds that to the top of your file.
### Gif Example
### Example in code
For example:
```python
# FILE: my_package/foo.py
from my_package.services import MagicRequests
...
```
Now you're editing a new file, and you haven't imported `MagicRequests` yet. If you type out what you want to import and invoke `ApyroriInsert`,
the file will go from:
```python
# FILE: my_package/bar.py
class MySweetSummerChild(MagicRequests):
pass
```
to
```python
# FILE: my_package/bar.py
from my_package.services import MagicRequests
class MySweetSummerChild(MagicRequests):
pass
```
Another benefit is that when you're doing type annotations for Python, it is SO annoying to always pick `from typing import List` from all the other places that define `List`. This way you just standardize it across your project.
## Installation
Current default setup uses ripgrep, so you should install that. Otherwise see `Advanced Configuration`
Otherwise you can just install as normal.
```vim
" Used for running jobs in lua
Plug 'nvim-lua/plenary.nvim'
" Actual plugin
Plug 'tjdevries/apyrori.nvim'
```
## Usage
```vim
" You may want to put this within a python only part of your config.
nmap ApyroriInsert
```
## Advanced Configuration
`apyrori.nvim` uses lua to do the configuration, so anywhere you have lua you can do the following:
```lua
require('apyrori.config').new(
'name_of_configuration',
{
command='grep',
args = function(text)
return {'the', 'commands', 'to', 'send', 'to', 'command'}
end,
-- results: the results of running the commands. Split on new lines
-- counts: the counts of the various different import styles. Most common will be used.
parser = function(results, counts)
for _, result in ipairs(results) do
local split_result = require('apyrori.util').string_split(result, ":", 4)
local value = split_result[4]
if counts[value] == nil then
counts[value] = 0
end
counts[value] = counts[value] + 1
end
end
},
true
)
```
You can see it in action here:
https://asciinema.org/a/4gKqKLPnSSQWQzWEcjveoIY0v
### To Do
- [ ] Make a pop up for "contested" imports, so you can choose one easily
- This is sort of done
- [ ] Make a pop up for "unknown" imports, so you can just type something and it will drop it at the top of your file
- [ ] Make a way to add "default" imports, so even if your project doesn't have them, we can add them anyways
- [ ] Make a "fuzzy" importer, and you can choose from a similar popup as the contested one