Rocksolid Light

News from da outaworlds

mail  files  register  groups  login

Message-ID:  

Perfect day for scrubbing the floor and other exciting things.

comp / comp.lang.python / Re: How to go about describing my software with a component diagram?

SubjectAuthor
o Re: How to go about describing my software with a component diagram?Thomas Passin

1
Subject: Re: How to go about describing my software with a component diagram?
From: Thomas Passin
Newsgroups: comp.lang.python
Date: Tue, 24 Dec 2024 21:44 UTC
References: 1 2 3 4 5
Path: eternal-september.org!news.eternal-september.org!feeder3.eternal-september.org!fu-berlin.de!uni-berlin.de!not-for-mail
From: list1@tompassin.net (Thomas Passin)
Newsgroups: comp.lang.python
Subject: Re: How to go about describing my software with a component diagram?
Date: Tue, 24 Dec 2024 16:44:26 -0500
Lines: 64
Message-ID: <mailman.24.1735077126.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>
<a6019819-a4f1-4dfa-aee4-e93440d743af@tompassin.net>
Mime-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
X-Trace: news.uni-berlin.de G827oQLXdmn6TR9pjONI1QEjvGdxhA8HH87QlNJyXu0w==
Cancel-Lock: sha1:iJhucV+rdxBB/nP2i5+5GLAQVMc= sha256:ZjsGwLMY/6QduaYzj6EnxxK7UaVef9lrxEtnPQW5G1U=
Return-Path: <list1@tompassin.net>
X-Original-To: python-list@python.org
Delivered-To: python-list@mail.python.org
Authentication-Results: mail.python.org; dkim=pass
reason="2048-bit key; unprotected key"
header.d=tompassin.net header.i=@tompassin.net header.b=ZU7DVnCG;
dkim-adsp=pass; dkim-atps=neutral
X-Spam-Status: OK 0.001
X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; 'containing': 0.05; 'is.':
0.05; 'modules': 0.07; 'url:mailman': 0.09; '=dn': 0.09;
'describe': 0.09; 'modules.': 0.09; 'other.': 0.09;
'received:23.83.212': 0.09; 'received:elm.relay.mailchannels.net':
0.09; 'that.': 0.15; 'url:listinfo': 0.15; '--------': 0.16;
'.py': 0.16; '>>>>': 0.16; 'accordingly': 0.16; 'diagram': 0.16;
'hints': 0.16; 'importing': 0.16; 'received:10.0.0': 0.16;
'received:23.83.212.17': 0.16; 'received:64.90': 0.16;
'received:64.90.62': 0.16; 'received:64.90.62.162': 0.16;
'received:bird.elm.relay.mailchannels.net': 0.16;
'received:dreamhost.com': 0.16; 'wrote:': 0.16; 'python': 0.16;
'larger': 0.17; "can't": 0.17; 'uses': 0.19; 'pm,': 0.19; 'to:addr
:python-list': 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; 'skip:-
10': 0.25; '>>>': 0.28; 'community,': 0.28; 'example,': 0.28;
'header:User-Agent:1': 0.30; 'subject:How': 0.31; 'program,':
0.31; "doesn't": 0.32; '---------': 0.32; 'python-list': 0.32;
'received:10.0': 0.32; 'received:mailchannels.net': 0.32;
'received:relay.mailchannels.net': 0.32; 'structure': 0.32;
'header:In-Reply-To:1': 0.34; "didn't": 0.34; 'package': 0.34;
'following': 0.35; 'close': 0.35; 'possibly': 0.36; 'main': 0.37;
'could': 0.37; 'use': 0.39; 'methods': 0.39; 'received:100': 0.39;
'something': 0.40; 'want': 0.40; 'tell': 0.60; 'including': 0.60;
'detail': 0.61; 'internal': 0.63; 'here': 0.63; 'full': 0.64;
'improved': 0.64; 'well': 0.65; 'header:Received:6': 0.67;
'received:64': 0.68; 'per': 0.68; 'relate': 0.69; 'little': 0.73;
'imports': 0.84; 'mar.': 0.84; 'represented': 0.84; 'convey':
0.91; 'width': 0.91
X-Sender-Id: dreamhost|x-authsender|tpassin@tompassin.net
ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1735076668; a=rsa-sha256;
cv=none;
b=x6Pr1783OXfNizSq0KhzlhOaPUCqgzYCrP+RGn0qdwJxEthn6b/OsKkbcP8wER2Bd6j6ex
QyxsFI0G8i4dfJAVOE0+OPGjSd7zMna/9auxjnuiE6B4FdGZfQOAXBiX11yk7lOquV/XH6
GNstH/MTxKEXEn9TKJ57cSUQhfzT1ailEpJUfcz0mQ4cpm4Wtrks3DL0SDkNdkPPZ7m2Bf
6rN3XNsIWusoubF7hpw6KA3htX09HT29dgMz4dNCi8N2s62MaoC25PYK6+RVSqqUPT9CWo
MZ5rudUVMASV5ALOpicEABHqGxeqwmA69RpdVcW35IPcYnALo1JS5N2pZeLADQ==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed;
d=mailchannels.net; s=arc-2022; t=1735076668;
h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
to:to:cc:mime-version:mime-version:content-type:content-type:
content-transfer-encoding:content-transfer-encoding:
in-reply-to:in-reply-to:references:references:dkim-signature;
bh=iFkgc2xU5j2hm7WLxIlZpzFAFSyQlstfSPG+qM+KHIA=;
b=9/ulLvSalruhMMwYiJeBDIVa12GoFv/Lg7z1Xz24ALcCbzu4xQR983WZkz0MYHCOMMNSYZ
cIrix4/2m3IL2EjuRxafGl8mO0XZiCQOV0bPqqwiIfOvLjno0Ce80SsEvvgfCJL5SicaxA
54IGODeYh83biMaokQVbfcNARzh1LVzNRp6nkKc8BcWgGEf/Y1XdBqXpSW3OoEQ4Fxghuq
jIP1JE6QkQBt1CLZOY5nYNEoPTkkIaXA6YiXqbs7O8lC9Djzkh+0nXcMeF8tefdLus0+Bb
Q662piRVqa2pql1vHP3ou2gG0bH0Vu/BMOYQO/yphWt+kGb+BqOI3GECMkVJ4g==
ARC-Authentication-Results: i=1; rspamd-7d788bbf85-595ns;
auth=pass smtp.auth=dreamhost smtp.mailfrom=list1@tompassin.net
X-Sender-Id: dreamhost|x-authsender|tpassin@tompassin.net
X-MC-Relay: Neutral
X-MailChannels-SenderId: dreamhost|x-authsender|tpassin@tompassin.net
X-MailChannels-Auth-Id: dreamhost
X-Interest-Stretch: 15fb2ac15fe7073b_1735076668987_2783850523
X-MC-Loop-Signature: 1735076668987:2627069683
X-MC-Ingress-Time: 1735076668987
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tompassin.net;
s=dreamhost; t=1735076668;
bh=iFkgc2xU5j2hm7WLxIlZpzFAFSyQlstfSPG+qM+KHIA=;
h=Date:Subject:To:From:Content-Type:Content-Transfer-Encoding;
b=ZU7DVnCG7uTpiaQwswyZmg+ksKqkPxffRsHYBE1sEk8XnQBTqFZa63xwei3yw++vC
/KQG7iualB8yxYdz10d1fM2PeKzO5E1bfZiRDHyjbHtW6LYLrad3hw9WWQZY8tO3bp
14Y6XhWh4pPc+IxLy69y4Fj8qBhGMgJNUXAbf7BXXyBjkPpAgT/s4qGRBVghCvwrkT
NBrdj+FG9vdfRsHZIVDHY/N/bh6Yga4/jgdp4EIg+aeVvS0nmAGg0G/6LQcF5z4jxq
hO5JCiwh5Wjv7Cvy3jCTwEyX9YTjnbFKgxjVZ7bPzAr55ldRDMZPx3P1ye6RTIIm0n
TNJw57FySprqA==
User-Agent: Mozilla Thunderbird
Content-Language: en-US
In-Reply-To: <CAGJtH9SihxgDSgYpVp1V7p-bKV1VM+WzG-bA2gR-_H14OWSTGw@mail.gmail.com>
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: <a6019819-a4f1-4dfa-aee4-e93440d743af@tompassin.net>
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>
View all headers

On 12/24/2024 4:08 PM, marc nicole via Python-list wrote:
> The full python package (pypi) being represented as the outermost frame
> here including the 4 sub-frames)
>
> Le mar. 24 déc. 2024 à 22:05, marc nicole <mk1853387@gmail.com> a écrit :
>
>> I want to convey the idea that main.py (main algorithm) imports 3 modules
>> (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.

As is, the diagram doesn't convey any of that. For example, main.py is
a program, not an algorithm. we can't tell that main.py imports three
modules. They might just as well be internal classes. If you want to
communicate something you need to say or show what that thing is.

This might be close to what you have said (I only show 2 of the 3
modules and I didn't have the page width for the bottom left-hand label) -

------------
| main.py | --implements--> Agorithm A
------------
/ \
imports imports
| |
↓ ↓
--------- --------
| V.py | | S.py | --implements--> Subalgorithm A.2
--------- --------

>> Le mar. 24 déc. 2024 à 21:56, dn via Python-list <python-list@python.org>
>> a écrit :
>>
>>> 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,
>>> =dn
>>> --
>>> https://mail.python.org/mailman/listinfo/python-list
>>>
>>

1

rocksolid light 0.9.8
clearnet tor