Path: ...!fu-berlin.de!uni-berlin.de!not-for-mail
From: George Fischhof <george@fischhof.hu>
Newsgroups: comp.lang.python
Subject: Re: How to go about describing my software with a component diagram?
Date: Tue, 24 Dec 2024 23:00:26 +0100
Lines: 73
Message-ID: <mailman.25.1735077642.2912.python-list@python.org>
References: <CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com>
 <f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info>
 <CAGJtH9TitodaW4uzrPg0omnEBzN=+FANLWYr+pdNu1MZAqeXvQ@mail.gmail.com>
 <CAGJtH9SihxgDSgYpVp1V7p-bKV1VM+WzG-bA2gR-_H14OWSTGw@mail.gmail.com>
 <CAFwcP0i5_YOjkrSTK2HP5X8Zd4+4XDsMfsuL6FQVxJPsR4j-zw@mail.gmail.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
X-Trace: news.uni-berlin.de 2VV3XxbNBBYbAfMh7ourNQ3+D200e6zfRgFEGAdQ81SQ==
Cancel-Lock: sha1:csXhEFLPEUj0ggv++lA/gNmTE/g= sha256:VO0sInMc3wk54a5K6vZz97vXadjzKjBnAc02zAxzykY=
Return-Path: <georgefischhof@gmail.com>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
Authentication-Results: mail.python.org; dkim=none reason="no signature";
 dkim-adsp=none (unprotected policy); dkim-atps=neutral
X-Spam-Status: OK 0.003
X-Spam-Evidence: '*H*': 0.99; '*S*': 0.00; 'containing': 0.05;
 'cc:2**2': 0.07; 'modules': 0.07; 'url:mailman': 0.09; '=dn':
 0.09; 'cc:addr:python-list': 0.09; 'dec.': 0.09; 'describe': 0.09;
 'other.': 0.09; 'received:209.85.219': 0.09; '>': 0.14;
 'url:listinfo': 0.15; '.py': 0.16; 'accordingly': 0.16; 'diagram':
 0.16; 'ezt': 0.16; 'hints': 0.16; 'importing': 0.16; 'pylint':
 0.16; 'url-ip:104.18.32/24': 0.16; 'url-ip:172.64.155/24': 0.16;
 'wrote:': 0.16; 'python': 0.16; 'larger': 0.17; 'code.': 0.19;
 'uses': 0.19; 'cc:addr:python.org': 0.20; 'url-
 ip:188.166.95.178/32': 0.20; 'url-ip:188.166.95/24': 0.20;
 'basically': 0.22; 'communicate': 0.22; 'code': 0.23; 'url-
 ip:188.166/16': 0.24; 'idea': 0.24; 'community,': 0.28; 'email
 addr:python.org>': 0.28; 'subject:How': 0.31; 'message-
 id:@mail.gmail.com': 0.31; 'python-list': 0.32; 'structure': 0.32;
 'there': 0.33; 'header:In-Reply-To:1': 0.34;
 'received:google.com': 0.34; 'package': 0.34; 'following': 0.35;
 'possibly': 0.36; 'main': 0.37; 'could': 0.37; 'received:209.85':
 0.37; 'class': 0.37; 'example': 0.37; 'received:209': 0.39; 'use':
 0.39; 'methods': 0.39; 'want': 0.40; 'including': 0.60; 'detail':
 0.61; 'remember': 0.61; 'george': 0.62; 'here': 0.63; 'full':
 0.64; 'improved': 0.64; 'per': 0.68; 'relate': 0.69; 'little':
 0.73; 'tools': 0.74; 'email name:<python-list': 0.84;
 'imports': 0.84; 'mar.': 0.84; 'represented': 0.84; 'convey':
 0.91; 'from:addr:george': 0.91
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1735077638; x=1735682438;
 h=cc:to:subject:message-id:date:from:in-reply-to:references
 :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id
 :reply-to;
 bh=OIHnNXDUSXGuY+i7y01zPhrGCKztTnyQcCDfi3oVV2k=;
 b=k8bEHtRuT1MjIq27ESBP9QXjg39npJQ4mV2krWAaZ5fJTw7ni/QmB8+kKZWyce/4zz
 POY659s3UnnzkjVh0r0hTRHnhlDOQJbiqrulyoSWMPs//+jxxUFbdAg8uL+TZogNZLSz
 znpqg8rO5k6UMa9IsfGeBLZfVJPIJ0Xli6GcmMCEmpPzIyn/6THSmaFq3X/4qpRlAS/n
 2/wZXmPTD8O/erQ/naQdcsbdu65IPD4jA7vPvErtXfOzpW3Y3qxphLuVoEtcEkp6ofMr
 chFUM3mp8ek1FAwGU+Hiq0Pej3MCU/6KrqxsPVrRsiOvHx/6d7dx+vsuijog8qEyMl8A
 KjVg==
X-Forwarded-Encrypted: i=1;
 AJvYcCVumcDso0gqerswpjWlKAjrifW1CW/8QuHEUXGiZD95H6Tx9Kw4oJKnqgWGyT7EKHZgIwwkoyisSw8aPDQ=@python.org,
 AJvYcCXBTqRN5BGuZWczxFpNQMCuEHaK+un/XOLIHiupE5UxdZOPq6u2I17viNzF0ereFEMaE6kPlQ==@python.org
X-Gm-Message-State: AOJu0YyUz3K/PN9p9BiVVOMu60+uZBbOv3nqjbeVusWpADypPYAdDr18
 94mYf1v+calC2OOs3VEgax77J0RJaoZxmq1q5OTThAv2/+ThCd6+gCZMPYnZTbg01LFVgeYqDtK
 Wbu6EC7KU/UPzR7f3AxvvVvAn1Yc=
X-Gm-Gg: ASbGnctSDGK3tn/D84cmeM7sR0V/44VUYdjZ1YUytPB62OwRpKYyMKEKz9vfhokqU+X
 YKfcFvvBcjrTzy/naZ1v8ixphQboDdXP9tII3Y/I=
X-Google-Smtp-Source: AGHT+IFZFXCJqMy0517xDIKck0WSHEHffiNEFnlBdBDwmyn/fJNm+LKFW69H+6PrIrUEJ+0ZmRp1rcTLJEzCGkSQKIg=
X-Received: by 2002:a05:6902:154f:b0:e39:8ef6:2231 with SMTP id
 3f1490d57ef6-e538c2653f5mr11759068276.21.1735077637846; Tue, 24 Dec 2024
 14:00:37 -0800 (PST)
In-Reply-To: <CAGJtH9SihxgDSgYpVp1V7p-bKV1VM+WzG-bA2gR-_H14OWSTGw@mail.gmail.com>
X-Content-Filtered-By: Mailman/MimeDel 2.1.39
X-BeenThere: python-list@python.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: General discussion list for the Python programming language
 <python-list.python.org>
List-Unsubscribe: <https://mail.python.org/mailman/options/python-list>,
 <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive: <https://mail.python.org/pipermail/python-list/>
List-Post: <mailto:python-list@python.org>
List-Help: <mailto:python-list-request@python.org?subject=help>
List-Subscribe: <https://mail.python.org/mailman/listinfo/python-list>,
 <mailto:python-list-request@python.org?subject=subscribe>
X-Mailman-Original-Message-ID: <CAFwcP0i5_YOjkrSTK2HP5X8Zd4+4XDsMfsuL6FQVxJPsR4j-zw@mail.gmail.com>
X-Mailman-Original-References: <CAGJtH9SeSw6CJEgs37MQ9DJEADeQy4M_bAYPH1yeFiJN+mTLYQ@mail.gmail.com>
 <f5054d26-39ca-4bbb-8eb7-a8b0455c7966@DancesWithMice.info>
 <CAGJtH9TitodaW4uzrPg0omnEBzN=+FANLWYr+pdNu1MZAqeXvQ@mail.gmail.com>
 <CAGJtH9SihxgDSgYpVp1V7p-bKV1VM+WzG-bA2gR-_H14OWSTGw@mail.gmail.com>
Bytes: 7466

marc nicole via Python-list <python-list@python.org> ezt =C3=ADrta (id=C5=
=91pont:
2024. dec. 24., K 22:09):

> The full python package (pypi) being represented as the outermost frame
> here including the 4 sub-frames)
>
> Le mar. 24 d=C3=A9c. 2024 =C3=A0 22:05, marc nicole <mk1853387@gmail.com>=
 a =C3=A9crit :
>
> > I want to convey the idea that main.py (main algorithm) imports 3 modul=
es
> > (V, S, M) (each of them containing .py scripts related to
> > different functionalities) and use their methods accordingly as per the
> > requirement: basically the structure of my code and how the modules
> relate
> > to each other.
> >
> > Le mar. 24 d=C3=A9c. 2024 =C3=A0 21:56, dn via Python-list <python-list=
@python.org
> >
> > a =C3=A9crit :
> >
> >> On 25/12/24 06:27, marc nicole via Python-list wrote:
> >> > Hello community,
> >> >
> >> > I have created a Python code where a main algorithm uses three
> different
> >> > modules (.py) after importing them.
> >> >
> >> > To illustrate and describe it I have created the following component
> >> > diagram?
> >> >
> >> >
> >> > [image: checkso.PNG]
> >> >
> >> > Could it be improved for better description and readability?
> >>
> >>
> >> Possibly - so little detail as to topic and any hints in the diagram
> >> redacted! What messages do you want to communicate with this diagram?
> >>
> >> Given that the three modules are subordinate contributors to the
> >> script/algorithm, place the three modules inside a larger "Algorithm"
> >> shape.
> >>
> >> --
> >> Regards,
> >> =3Ddn
> >> --
> >> https://mail.python.org/mailman/listinfo/python-list
> >>
> >
> --
> https://mail.python.org/mailman/listinfo/python-list



Hi,

also there are some tools which can generate class hierarchy diagram from
code.
for example here is a post
https://stackoverflow.com/questions/77421030/how-to-generate-the-uml-diagra=
m-from-the-python-code

pyreverse is now part of pylint if I remember well.

BR
George

>
>