Skip to main content

Library to create cross-platform native context menus.

Project description

๐Ÿ—‚๏ธcontext_menu build passing readthedocs pip Downloads

logo

๐Ÿ’ป A Python library to create and deploy cross-platform native context menus. ๐Ÿ’ป

Documentation available at: https://context-menu.readthedocs.io/en/latest/


example usage


Table of Contents

โš™ Features โš™

This library lets you edit the entries on the right click menu for Windows and Linux using pure Python. It also allows you to make cascading context menus!

context_menu was created as due to the lack of an intuitive and easy to use cross-platform context menu library. The library allows you to create your own context menu entries and control their behavior seamlessly in native Python. The library has the following features:

  • Written in pure python with no other dependencies
  • Extremely intuitive design inspired by Keras Tensorflow
  • Swift installation from Python's Package Manager (pip)
  • Painless context menu creation
  • Cascading context menu support
  • The ability to natively integrate python functions from a context entry call
  • Detailed documentation

๐Ÿ™‹ What is the context menu? ๐Ÿ™‹

The context menu is the window that is displayed when you right click:

img.png

The context menu is different depending on what was right clicked. For example, right clicking a folder will give you different options than right clicking a file.

๐Ÿ–ฅ๏ธ What Operating Systems are supported? ๐Ÿ–ฅ๏ธ

Currently, the only operating systems supported are:

  • Windows 7
  • Windows 10
  • Windows 11
  • Linux (Using Nautilus)

๐Ÿ What Python versions are supported? ๐Ÿ

All python versions 3.1 and above are supported.

๐Ÿ’ฝ Installation ๐Ÿ’ฝ

If you haven't installed Python, download and run an installer from the official website: https://www.python.org/downloads/

Once you have Python, the rest is super simple. Simply just run the following command in a terminal to install the package:

python -m pip install context_menu

or if you're on Linux:

python3 -m pip install context_menu

Note: If you're on Windows and it says the command isn't recognized, make sure to add Python to your path and run the command prompt as administrator

๐Ÿ•น๏ธ Quickstart ๐Ÿ•น๏ธ

Let's say you want to make a basic context menu entry when you right click a file.

  1. If you haven't already Install the library via pip:
python -m pip install context_menu
  1. Create and compile the menu:

It's super easy! You can create entries in as little as 3 lines:

from context_menu import menus

fc = menus.FastCommand('Example Fast Command 1', type='FILES', command='echo Hello')
fc.compile()

example fast command

All you have to do is import the library and define the type of context entry you want. The options are:

  • A context menu (an entry that has more entries)
  • A fast command (a single context menu entry to kick a running script)
  • A context command which can be added to menus for more complex commands

You can also create much more complicated nested menus:

def foo2(filenames, params):
    print('foo2')
    print(filenames)
    input()


def foo3(filenames, params):
    print('foo3')
    print(filenames)
    input()


if __name__ == '__main__':
    from context_menu import menus

    cm = menus.ContextMenu('Foo menu', type='FILES')
    cm2 = menus.ContextMenu('Foo Menu 2')
    cm3 = menus.ContextMenu('Foo Menu 3')

    cm3.add_items([
        menus.ContextCommand('Foo One', command='echo hello > example.txt'),
    ])
    cm2.add_items([
        menus.ContextCommand('Foo Two', python=foo2),
        cm3,
    ])
    cm.add_items([
        cm2,
        menus.ContextCommand('Foo Three', python=foo3)
    ])

    cm.compile()

second Example

All context menus are permanent unless you remove them.

๐Ÿค– Advanced Usage ๐Ÿค–

The ContextMenu Class

The ContextMenu object holds other context objects. It expects a name, and the activation type if it is the root menu(the first menu). Only compile the root menu.

ContextMenu(name: str, type: str = None)

Menus can be added to menus, creating cascading context menus. You can use the {MENU}.add_items{ITEMS} function to add context elements together, for example:

cm = menus.ContextMenu('Foo menu', type='DIRECTORY_BACKGROUND')
cm.add_items([
    menus.ContextMenu(...),
    menus.ContextCommand(...),
    menus.ContextCommand(...)
])
cm.compile()

You have to call {MENU}.compile() in order to create the menu.

The ContextCommand Class

The ContextCommand class creates the selectable part of the menu (you can click it). It requires a name, and either a Python function or a command (but NOT both) and has various other options

ContextCommand(name: str, command: str = None, python: 'function' = None, params: str = None, command_vars: list = None)

Python functions can be passed to this method, regardless of their location. However, the function must accept only two parameters filenames, which is a list of paths*, and params, the parameters passed to the function. and if the function is in the same file as the menu, you have to surround it with if __name__ == '__main__':

# An example of a valid function
def valid_function(filenames, params):
    print('Im valid!')
    print(filenames)
    print(params)


# Examples of invalid functions
def invalid_function_1(filenames, param1, param2):
    print('Im invalid!')
    print(filenames)


def invalid_function_2(params):
    print('Im invalid!')
    print(params)

Any command passed (as a string) will be directly ran from the shell.

The FastCommand Class

The FastCommand class is an extension of the ContextMenu class and allows you to quickly create a single entry menu. It expects a name, type, and command/function.

FastCommand(
    name: str, type: str, command: str = None, python: 'function' = None, params: str = '', command_vars: list = None)
def foo1(filenames, params):
    print(filenames)
    input()


if __name__ == '__main__':
    from context_menu import menus

    fc = menus.FastCommand('Example Fast Command 1', type='FILES', python=foo1)
    fc.compile()

The removeMenu method

You can remove a context menu entry easily as well. Simply call the 'menus.removeMenu()' method.

removeMenu(name: str, type: str)

For example, if I wanted to remove the menu 'Foo Menu' that activated on type 'FILES':

from context_menu import menus

menus.removeMenu('Foo Menu', 'FILES')

and boom! It's gone ๐Ÿ˜Ž

The params Command Parameter

In both the ContextCommand class and FastCommand class you can pass in a parameter, defined by the parameter=None variable. This value MUST be a string! This means instead of passing a list or numbers, pass it as a string separated by spaces or whatever to delimitate it.

fc = menus.FastCommand('Example Fast Command 1', type='FILES', python=foo1, params='a b c d e')
fc.compile()

For more information, see this.

Works on the FastCommand and ContextCommand class.

command_vars Command Parameter

If you decide to pass a shell command, you can access a list of special variables. For example, if I wanted to run a custom command with the file selected, I could use the following:

fc = menus.FastCommand('Weird Copy', type='FILES', command='touch ?x', command_vars=['FILENAME'])
fc.compile()

which would create a new file with the name of whatever I selected with an 'x' on the end. The ? variable is interpreted from left to right and replaced with the selected values (see this).

All of the preset values are as follows:

Name Function
FILENAME The path to the file selected
DIR/DIRECTORY The directory the script was ran in.
PYTHONLOC The location of the python interpreter.

Works on the FastCommand and ContextCommand class.

Opening on Files

Let's say you only want your context menu entry to open on a certain type of file, such as a .txt file. You can do this by adding a type variable to the ContextCommand or FastCommand class.

fc = menus.FastCommand('Weird Copy', type='.txt', command='touch ?x',
                       command_vars=['FILENAME'])  # opens only on .txt files
fc.compile()

Now you'll only see the "Weird Copy" menu entry when you right click a .txt file.

Activation Types

There are different locations where a context menu can fire. For example, if you right click on a folder you'll get different options than if you right click on a file. The type variable controls this behavior in the library, and you can reference this table to determine the type:

Name Location Action
FILES HKEY_CURRENT_USER\Software\Classes\*\shell\ Opens on a file
DIRECTORY HKEY_CURRENT_USER\Software\Classes\Directory\shell Opens on a directory
DIRECTORY_BACKGROUND HKEY_CURRENT_USER\Software\Classes\Directory\Background\shell Opens on the background of the Directory
DRIVE HKEY_CURRENT_USER\Software\Classes\Drive\shell Opens on the drives(think USBs)

I strongly recommend checking out the examples folder for more complicated examples and usage.

You can check out the official documentation here.


๐Ÿ Goals ๐Ÿ

This project tackles some pretty big issues, and there's definetly some goals that I'd like to accomplish. The current roadmap is as follows:

  • Support for other Linux distributions
  • Better approach to the Linux GNOME integration
  • Mac support
  • Bypass 16 entry limit on windows

If by all means you want to help reach these milestones, see contribution below.

๐Ÿ™Œ Contribution ๐Ÿ™Œ

I really want to add support for MacOS, but I don't have the experience required to implement it.

Contributing is super simple! Create an additional branch and make a pull request with your changes. If the changes past the automated tests, it will be manually reviewed and merged accordingly.

Any and all help is appreciated, and if you have any questions, feel free to contact me directly.

๐Ÿ““ Important notes ๐Ÿ““

  • Almost all the errors I've encountered in testing were when the code and the functions were in the same file. You should make a separate file for the code or surround it with if __name__ == '__main__':.
  • On windows, there's currently a 16 entry limit on the context menu.

๐Ÿ’ป Freshen - A context_menu project! ๐Ÿ’ป

Feel free to check out a file sorter program I made that directly implements this library.

Readme Card

๐Ÿ’™ Support ๐Ÿ’™

All my work is and always will be free and open source. If you'd like to support me, please consider leaving a โญ star โญ, as it motivates me and the community to keep working on this project.

Thanks for reading!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

context_menu-1.3.1.tar.gz (18.2 kB view hashes)

Uploaded source

Built Distribution

context_menu-1.3.1-py3-none-any.whl (15.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page