PythonUmlClass

Create a python class diagram

Read this in other languages: English, 日本語

for ubuntu
$ sudo apt install plantuml
$ sudo apt install python3.12-venv
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install astor

install google-chrome
$ echo "deb http://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google.list
$ wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
$ apt update
$ apt -y install google-chrome-stable

Install the gem and add to the application's Gemfile by executing:

$ bundle add python_uml_class

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install python_uml_class

$ start_python_uml_class.rb

• Feature: Added python_path setting in setting.json to allow specifying a custom Python path when executing the formatter script.
• Feature: Added class_color and color_class_name settings in setting.json. Classes matching the color_class_name regular expression will be displayed with the specified class_color along with their inheritance (-|>) and composition (*--) relationship lines.
• Enhancement: Improved the extraction of class compositions to properly detect class instantiations inside parentheses (e.g., chat_history.append(HumanMessage(content=...))).
• Enhancement: Modified class extraction to output fully qualified module names (e.g., langchain_core.messages.HumanMessage) when an alias or module path is specified via from module import Class or import module as alias.
• Enhancement: Filtered the extracted objects to include only the classes explicitly imported or defined locally within the parsed file.
• Enhancement: Updated README.md to include instructions for setting up a Python virtual environment (python3 -m venv .venv).
• Bug Fix: Addressed an issue where variables defined with class_ prefix (like class_var) or variables without assignments but containing type hints (like global_var: int) were incorrectly identified.
• Bug Fix: Fixed a bug where multi-line strings (""" or ''') or empty lines containing whitespace only within class functions caused indentation miscalculations, leading to local variables being improperly recognized as class or global variables.
• Bug Fix: Fixed uninitialized constant Rack::Server error and improved Rack 3 support by unifying the server usage to Rackup::Server while maintaining backward compatibility with Rack::Server for older Rack 2 environments.
• Bug Fix: Fixed an issue where the WebSocket connection URL in main.js was missing or updating to the wrong port.
• Bug Fix: Resolved SinatraWebsocket::Error::ConfigurationError by explicitly passing :server => 'thin' to ensure websockets work smoothly in async environments.
• Bug Fix: Handled an Encoding::CompatibilityError where incoming WebSocket messages from the browser were incorrectly interpreted as US-ASCII. They are now correctly parsed as UTF-8.
• Bug Fix: Fixed a crash no implicit conversion of nil into String in create_uml_class.rb which occurred when @config was nil.

You can use Docker to set up a development and testing environment for Ubuntu 22.04 and 24.04.

1. Move to test/docker/ubuntu.

   $ cd test/docker/ubuntu

2. Build and start the container using docker compose.

   • For Ubuntu 22.04:

     $ docker compose up -d --build

   • For Ubuntu 24.04:

     $ docker compose -f docker-compose-24.04.yml up -d --build

3. Log in to the container to run tests or the application. (The source code is mounted at /work inside the container)

   • For Ubuntu 22.04:

     $ docker exec -it ubuntu bash

   • For Ubuntu 24.04:

     $ docker exec -it ubuntu-24.04 bash

4. Run tests inside the container.

   $ cd /work
   $ bundle install
   $ bundle exec rspec

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to pythongems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/kuwayama1971/PythonUmlClass.

The gem is available as open source under the terms of the MIT License.