Python és COM

dokumentum verzi?k:

• 1.1 verzi?(2000”N07ŒŽ25“ú.):
  1. kimaradt az el?z? verzi?b?l a CoInitialize és CoUnitialize f?ggvények használata,
  2. a makepy.py használatához adtam némi kiegész?tést,
  3. a forrásokat formáztam
• 1.0 verzi?(2000”N06ŒŽ23“ú.): ezt már használhat?nak itéltem

Ezzel a le?rással azoknak akarok seg?teni, akik kezd?k a fenti témak?rben és már megfogalmaz?dott benn?k az alábbi kérdések valamelyike:

• Mi a csuda az a COM?
• Python-b?l hogyan érhetek el COM komponenseket?
• Lehetséges-e COM komponensek kész?tése Python-ban?

A cikkben szerepl? mintaprogramok kipr?bálásához sz?kséged lesz a k?vetkez?kre:

• Windows 9x, Windows NT vagy Windows 2000 operáci?s rendszer.
• Python telep?t? készlet a fenti operáci?s rendszerekhez
• Mark Hammond win32all csomagja
• Windows 95 esetében talán COM friss?tés is kell, de ebben nem vagyok biztos...
• Microsoft Office
• Magukra a minta programokra

Mi a csuda az a COM

Egyfajta bináris/hál?zati szabvány szoftver komponensek használatára és egy?ttm?k?désére. A COM ?n. interfészekkel dolgozik, amiken kereszt?l hozzáférhet?nk a komponensek funkcionalitásához. A COM maga is el?re definiál egy rakat interfészt. Egy interfész val?jában egy "virtual base class", már akinek ez a C++-os hablaty mond valamit. Nek?nk jelenleg elég, ha egy interfész kapcsán egy olyan class-ra gondolunk, akinek mindeféle met?dusai vannak, de a met?dusok implementáci?ját nem az interfész maga hanem egy másik class - a COM class - tartalmazza. T?bb interfész is tartozhat egy ilyen COM class-hoz, s?t a gyakorlatban legalább kett? interfésze mindig van.

Azt is szokták mondani, hogy egy interfész nem más mint egy kommunikáci?s szerz?dés a komponens és a kliens program k?z?tt. Például egy bizonyos interfészt k?l?nb?z? komponensek teljesen eltér? m?don is implementálhatnak, de az ?ket használ? kliens program számára ez nem is lényeges. Gondoljatok az ActiveX kontrolokra: mindegyik másképp néz ki és más célt szolgál(textbox, label, listbox stb.), de mégis támogatnak olyan el?re specifikált interfészeket, amit?l ?k ActiveX kontrolokk? válnak (és pl. a VB fejleszt? k?rnyezetében egységes használatot/viselkedést eredményeznek).

Egy COM komponens fizikailag valamilyen modulban találhat?, ami lehet:

• egy dll. Ezt szokás inprocess szervernek is nevezni.
• egy exe. Ezt szokás out of process szervernek nevezni.

Mivel COM komponenseket használhatunk ?gy is, hogy a komponens, amit használunk fizikailag egy másik gépen fut, ebben az esetben egy dll is out of process lesz!

A COM bináris volta miatt nem nyelvf?gg? megval?s?tás. Természetesen a k?l?nb?z? programozás nyelvekben és fejleszt? k?rnyezetekben a COM támogatottsága eltér?. Például Visual Basic-ben API használat nélk?l csak a default interfész érhet? el és nem lehet "mászkálni" az interfészek k?z?tt. A bináris volta miatt sz?kség van valamilyen nyelvf?ggetlen eszk?zre, ami informáci?t szolgáltat a komponensekr?l a k?l?nb?z? fejleszt? eszk?z?knek. Erre gyakorlatilag két megoldást k?nál a Microsoft:

• IDL(Interface Definition Language): ez egy Ascii fájl, ami le?rja a komponensek funkcionalitását.
• Type Library: ez az IDL fájl bináris formája, ami vagy k?l?n .tlb fájlban van vagy maga a modul tartalmazza.

A COM a komponensek, interfészek és gyakorlatilag mindennek az azonos?tására 128 bit hossz? számokat használ, amir?l az áll?tja hogy igen nagy val?sz?n?séggel nem fordul el? két azonos. Lehet ProgId-vel is hivatkozni, ami egy beszédes név, de mivel ez a fejleszt? találmánya ebb?l lehet azonos. A COM csak a 128 bites azonos?t?knak hisz. T?bb fajta elnevezés?k is van ezeknek az ID-knek, ami a felhasználási ter?let?kre utal:

• GUID: Globally Unique ID
• UUID: Universally Unique ID
• CLSID: COM class azonos?t?
• IID: interfész azonos?t?

ID el?áll?tása lehetséges: API h?vással, guidgen.exe-vel stb.

Néhány a COM által el?re definiált interfész:

• IUnknown: ebb?l származik minden más interfész, ezért három met?dusa minden interfészben megtalálhat?:
  • QueryInterface: ezzel lehet egy IID-val azonos?tott másik interfészre átmenni
  • AddRef: a bels? refcount-ot n?veli
  • Release: a bels? refcount-ot cs?kkenti és ha ez 0-v? vált, akkor kit?rli a komponenst
• IDispatch: néha automation interfészként is hivatkoznak r?. Legfontosabb met?dusa az Invoke, ami paraméterként a megh?vand? met?dus nevét és annak paramétereit kapja meg. Ez az interfész dinamikus met?dus h?vást/használatot tesz lehet?v?.
• IClassFactory: ez az interfésze(IUnknown-on k?v?l) a másik COM class-nak, ami minden modulban benne van. Ez a "COM class gyár" interfész, szabályosan ennek használatával hozunk létre egy ?j instance-ot. Direktben nem nagyon használjuk, de például CoCreateInstance COM API is ezt használja.
• IConnectionPointContainer, IConnectionPoint: ha vannak események is, akkor ezekre az interfészekre van sz?kség ahhoz, hogy a komponensnek az eseménykezel?nket(sink) át tudjuk adni.

Nem volt célom, hogy 5 mondatban megvilág?tsam a COM minden rejtelmét, csak annyit akartam a COM-r?l ?rni, hogy az alapján a python-os anyag és programok már érthet?ek legyen. Vég?l még egy r?vid terminol?giai sz?tár, ami további COM-os cikkek megértésében lehet seg?tségedre:

• Modul: dll vagy exe, ami az egész moty?t tartalmazza
• COM class: vagy component class, vagy COM object. ƒ† val?s?tja meg a funkcionalitást. ƒ†t fogjuk elérni k?l?nb?z? interfészeken kereszt?l. Gyakorlatilag az interfészeknek ? mint virtual base class-oknak ? a leszármazottja.
• Interface: ez egy virtual base class, aminek a met?dusait majd inplemetálnunk kell a COM class-ban. Az angol doksikban el?szerettel emlegetik az interfészeket mit egyfajta szerz?dés a kliens és a szerver k?z?tt(verzi? k?vetés).
• Class object: vagy class factory, vagy class factory object. T?bbnyire minden modulban van egy ilyen. Ki lehet hagyni, ha csak nagyon fapados API-kat használunk, de a célja az hogy magaszint? API-kat használva seg?tségével áll?tsuk el? az instance-okat. A ?location transparency? az ami miatt fapados API-k használata nem javasolt és jobb ha szerver?nkben implemetálunk egy class factory-t, mert akkor az infrastrukt?ra megk?mél benn?nket egy csom? rabszolgamunkát?l. Ez egy speciális COM class, akinek legalább egy interésze van az IClassFactory. Feladata instance-ok létrehozása a COM class-okb?l.
• Dual interface az az interface, aminek met?dusait vtable-n kereszt?l és IDispatch::Invoke seg?tségével is el tudjuk érni.
• [OLE] Automation az a funkcionalitás, amit IDispatch –b?l származtatott interface-en kereszt?l érhet?nk el. COM el?tt is létez? technol?gia, ami mint egy interface ép?lt be a COM-ba.
• Proxy: a TCP/IP-s proxy-hoz hasonl? funkcionalitás?. Proxy-ra van sz?kség pl. egy out of process komponens elérése során, ekkor a kliens a proxy-n kereszt?l kapcsol?dik a szerverhez. A kliens számára ez láthatatlan az infrastrukt?ra automatikusan létrehozza, ha sz?kség van r?.
• Stub: a proxy párja a szerver oldalon, ? reprezentálja a klienst a szerver számára a szerver processben.
• Sink: a kliens oldalon létrehozott COM instance akinek az IUnknown interfészét adjuk át egy connection point-nak. A sink-ben t?rténik az események kezelése.
• Aggregation és containment/delegation : mind a két esetben egy COM komponens más COM komponenseket használ a funkci?k implemetálása során. Containment/delegation-r?l beszél?nk, ha a k?ls? komponens felhasználja a bels?k interfészeit a saját interfészek implemetálása során. Aggregation-r?l beszél?nk, ha a k?ls? komponens egy vagy t?bb interfészét nem implemetálja, hanem egy másik COM komponens interfészét használja, ami k?v?lr?l ?gy látszik mintha a k?ls?ben lenne az implementáci?.
• Reference counting: ezzel k?vetj?k egy, hogy egy instance-ot használ-e még valaki, vagy már t?r?lhet?.
• Inprocess szerver: mikor a szerver komponens fizikai megjelenése dll és a kliens is a szerver is azonos gépen fut. Ekkor a kliens process-en bel?l létezik a szerver komponens.
• Out of process szerver: mikor a szerver exe vagy olyan dll, akit hál?zaton kereszt?l egy másik gépen ér?nk el. Ha dll a szerver és egy másik gépen fut, akkor természetesen a COM biztos?t egy process-t a számára, amin bel?l futni fog, azaz a fejleszt?nek nem kell feltétlen?l extra er?fesz?téseket tennie azért hogy inprocess szerverét hál?zaton kereszt?l távoli gépr?l futtassák.
• Type Library: lehet ?náll? fájl vagy tartalmazhatja a modul is. Az interfész defin?ci?kat tartalmazza bináris formátumban(mint az IDL fájl, de az ASCII).

Python-b?l hogyan érhetek el COM komponenseket

A Python lehet?séget ad arra, hogy a COM-ot azon a szinten kezelj?k, amire mondjuk C++-ban van lehet?ség, de támogatja a másik végletet is - amire j? példa Visual Basic - mikor a m?k?dési mechanizmus nagy része rejtve marad el?l?nk.

Legegyszer?bb eset: Dispatch használata

Ha nincs eseménykezelés és, akkor legegyszer?bb a win32com.client.Dispatch használata. A win32com.client.Dispatch maga d?nti el, hogy dinamikusan használja a komponenst vagy statikusan. A makepy.py utility seg?tségével el?re legenrálhatunk támogat? class-okat a COM komponenshez, ami bizonyos esetekben stabilabb m?k?dést eredményez(tipus ellen?rzés stb.). A legut?bbi win32all (build 132) esetében már a támogat? class-ok package-be vannak szervezve és csak azok a class-ok vannak ténylegesen legenerálva akiket használni akarunk. A makepy.py használata '-i' paraméterrel ki?r az outputra néhány sort, amit script?nkbe másolva biztos?tani tudjuk, hogy a támogat? classok mindenképpen létezzenek. A scriptek végén ajánlott megh?vni a pythoncom.CoUninitalize f?ggvényt. Minden thread-ben miel?tt COM-ot használnánk meg kell h?vni a pythoncom.CoInitialize vagy a pythoncom.CoInitializeEx f?ggvényeket. Ezekben a példákban azért nem h?vjuk meg, mert a f? thread-ben az "import pythoncom" kiadásával automatikusan megh?vásra ker?l a pythoncom.CoInitialize. Figyelem: egy thread-ben t?bbsz?r is h?vhat? a pythoncom.CoInitialize vagy a pythoncom.CoInitializeEx(azonos paraméterrel), de ugyan annyi pythoncom.CoUninitalize h?vásra is sz?kség van. A példa program Excel automation-t mutat be.

Python forrás

Események kezelése, ha van type library: DispatchWithEvents használata

Eseménykezeléshez a kliens oldalon egy sink-re, egy minimális COM class-ra van sz?kség. A sink IUnknown interfészét adjuk át a megfelel? connection point -nak(Advise met?dus). Python-ban ebb?l a legegyszer?bb esetben szinte semmit sem látunk csak egy class-t, akinek "On"+eseménynév nev? met?dusai vannak. A DispatchWithEvents-nek paraméterként átadjuk ezt a class-t, a t?bbit elintézi a m?g?ttes infrastrukt?ra. Ez a megoldás type library-t igényel. Ha még nincs python class generálva a type library-b?l, akkor meg fog jelenni a makepy.py progress bar-ja is(másodszori futtatásnál már nem). A példában Word-?t ind?tunk el, majd kilép?nk bel?le és a kilépés tényét - mint eseményt - kapjuk el.

FIGYELEM: eddig kisbet?/nagybet? nem szám?tott, de mivel támogat? Python class-ok lettek generálva itt szám?t ez is!

A win32com\gen_py al? ker?lnek a generált modulok, ahol az eseményeket kezel? met?dusok protot?pusait is megtaláljuk.

Python forrás

Események kezelése, ha nincs type library: DispatchWithEvents megker?lése

Type library hiányában az el?z? egyszer? m?dszer nem járhat?, kénytelenek vagyunk egy kicsit alacsonyabb szintre menni. A példa az ebben a cikkben ismertetett python szerver komponenst használja.

Python forrás

Nem lokális komponensek elérése: DispatchEx használata

Mi van, ha az els? példát(Excel automation) ?gy akarjuk megcsinálni, hogy az Excel egy másik gépen fusson? A python forrásban minimális változásra van sz?kség: Dispatch helyett DispatchEx-t kell használni, mert az ut?bbinak azt is meg lehet mondani, hogy melyik gépen hozza létre a komponenst. A példa m?k?déséhez sz?kséges a rendszer átkonfigurálása is! Csak Windows NT-re tudom, hogy mit kell csinálni mert csak ezt használunk.

A dcomcnfg.exe seg?tségével a távoli gépen:

1. engedélyezt?k a DCOM-ot
2. magunknak adjunk jogot komponens ind?tásra/manipulálásra(default launch/access permission).
3. Az Excel esetében áll?tsuk be, hogy az identity az interactive user legyen(csak azért, hogy Task Manageren kereszt?l is piszkálhat? legyen) a security pedig a default beáll?tásokkal m?k?dj?n.

A dcomcnfg.exe seg?tségével a lokális gépen engedélyezz?k a DCOM-ot. Ez kell mert alapértelmezés szerint nincs engedélyezve.

A példa szintén Excel-t, használ és megegyezik a korábbi példával csak most az Excel a távoli gépen fut.

Python forrás

Lehetséges-e COM komponensek kész?tése Python-ban

Természetesen a válasz igen. Python-ban nincs "virtual base class" fogalom mint C++-ban, ezért az interfészek nem ?náll? class-okként jelennek meg. Nagyon leegyszer?s?tve a COM komponens gyártásának menete Python-ban:

1. Létrehozunk egy class-t azokkal a met?dusokkal, amelyek - egy része vagy mind - majd a a komponens?nk egyetlen interfészének met?dusai lesznek.
2. A class-nak lesz néhány speciális tulajdonsága, amit a m?g?ttes infrastrukt?ra használ fel a komponensként publikálás során:
   • _public_methods_: azokat a met?dusokat kell egy listában felsorolni(a nev?ket), akiket meg akarunk jelen?teni a COM interfész?nk met?dusaként
   • _public_attrs_: azokat a tulajdonságokat kell egy listában felsorolni(a nev?ket), akiket meg akarunk jelen?teni a COM interfész?nk met?dusaként
   • _reg_desc_: valami duma a komponens?nkr?l
   • _reg_clsid_: class azonos?t?, amit valamilyen m?don el? kell áll?tani(guidgen.exe, pythoncom.CreateGuid() stb.)
   • _reg_progid_: ez lesz a ProgId, amit például Python-b?l vagy Visual Basic-b?l használhatunk
3. A python modulunkhoz hozzápakolunk egy néhány soros regisztráci?s k?dot.

Ezzel kész is vagyunk. Lefuttava a regisztráci?s k?dot máris használatba vehetj?k a frissen elkész?lt COM komponens?nket.

A mintaként mellékelt példa egyetlen met?dusa az echo, ami annyiszor visszhangozza a kapott paramétert, amennyi a publikus count tulajdonságban be van áll?tva.

Python forrás

Események generálásához még némi kiegész?tésre van sz?kség?nk. Valahogy IConnectionPoint, IConnectionPointContainer interfészekkel kell kiegész?teni a komponens?nket:

1. Azonos?t?kat kell generálnunk a connection point interfészeinknek.
2. A class-unkat a "win32com.server.connect.ConnectableServer"-b?l kell származtatni. Ez fogja biztos?tani a fentebb eml?tett interfészek kezelését a számunkra.
3. A _connect_interfaces_ class változ?ban(lista) fel kell sorolni a connection point interfészek azonos?t?it(hogy ConnectableServer tudja kikr?l van sz?).
4. Figyelni kell r?, hogy a _public_methods_ class változ? a ConnectableServer public met?dusait is tartalmazza.
5. A class-unknak legyen __init__ met?dusa, ahol h?vjuk meg a ConnectableServer __init__ met?dusát.
6. Sz?kség?nk van még egy met?dusra, akit a ConnectableServer _BroadcastNotify met?dusának adunk meg paraméterként, mikor eseményt generálunk.

Az el?z? példa m?dos?tása: az echo met?dus "IntVolt" eseményt generál, ha a paraméter int tipus?, azaz egy connection point interfész?nk lesz egyetlen event-el(IntVolt).

FIGYELEM: Visual Basic-b?l ezt az eseményt nem tudjuk kezelni, mert a "Dim WithEvents" nyelvi lehet?ség type library-ra ép?l, az meg itt nincs!

Python forrás

Di?hélyban ennyi a COM komponensek kész?tése Python-ban.

ƒˆsszegzés

Remélem a cikk elégséges informáci?kat tartalmaz a Python-COM páros használatához. Egy kés?bbi cikben szándékozok visszatérni a m?g?ttes m?k?dési mechanizmus ismertetésére és az ?gy megnyil? plussz lehet?ségek bemutatására.

Kiss ƒ`rpád