search

pcdshub / pytmc

Generate EPICS IOCs and records from TwinCAT projects - along with many TwinCAT project tools
https://pcdshub.github.io/pytmc/
Other
10 stars 11 forks source link

MNT: show summary paths relative to the project root #141

Closed klauer closed 4 years ago

klauer commented 4 years ago

Just for readability. See example below.

Before:

$ pytmc summary ../lcls-twincat-general/LCLSGeneral/LCLSGeneral.tsproj  --plcs
PLC Project (1): LCLSGeneral
============================

    Project path: /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/LCLSGeneral.plcproj
    TMC path:     /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/LCLSGeneral.tmc
    AMS ID:
    IP Address:    (* based on AMS ID)
    Port:         851

    Source files:
        1.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/Data types/Misc/ST_EcDevice.TcDUT
        2.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/Data types/Misc/ST_FbDiagnostics.TcDUT
        3.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/Data types/Misc/ST_System.TcDUT
        4.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/GVLs/DefaultGlobals.TcGVL
        5.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Functions/FB_EcatDiag.TcPOU
        6.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Functions/FB_Index.TcPOU
        7.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Functions/FB_XKoyoPLCModbus.TcPOU
        8.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/FB_Logger.TcPOU
        9.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/FB_LogMessage.TcPOU
        10.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/GVL_Logger.TcGVL
        11.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/DUTs/E_MesgSevr.TcDUT
        12.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/DUTs/E_MessengerState.TcDUT
        13.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/DUTs/E_Subsystem.TcDUT
        14.) /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral/LCLSGeneral/POUs/Logger/SYSTEM_TIME_TO_RFC3339.TcPOU

    GVLs:
        1.) DefaultGlobals
        2.) GVL_Logger

After:

(pytmc) klauer-osx:pytmc klauer$ pytmc summary ../lcls-twincat-general/LCLSGeneral/LCLSGeneral.tsproj  --plcs
PLC Project (1): LCLSGeneral
============================

    Project root: /Users/klauer/docs/Repos/lcls-twincat-general/LCLSGeneral
    Project path: LCLSGeneral/LCLSGeneral.plcproj
    TMC path:     LCLSGeneral/LCLSGeneral.tmc
    AMS ID:
    IP Address:    (* based on AMS ID)
    Port:         851

    Source files:
        1.) LCLSGeneral/Data types/Misc/ST_EcDevice.TcDUT
        2.) LCLSGeneral/Data types/Misc/ST_FbDiagnostics.TcDUT
        3.) LCLSGeneral/Data types/Misc/ST_System.TcDUT
        4.) LCLSGeneral/GVLs/DefaultGlobals.TcGVL
        5.) LCLSGeneral/POUs/Functions/FB_EcatDiag.TcPOU
        6.) LCLSGeneral/POUs/Functions/FB_Index.TcPOU
        7.) LCLSGeneral/POUs/Functions/FB_XKoyoPLCModbus.TcPOU
        8.) LCLSGeneral/POUs/Logger/FB_Logger.TcPOU
        9.) LCLSGeneral/POUs/Logger/FB_LogMessage.TcPOU
        10.) LCLSGeneral/POUs/Logger/GVL_Logger.TcGVL
        11.) LCLSGeneral/POUs/Logger/DUTs/E_MesgSevr.TcDUT
        12.) LCLSGeneral/POUs/Logger/DUTs/E_MessengerState.TcDUT
        13.) LCLSGeneral/POUs/Logger/DUTs/E_Subsystem.TcDUT
        14.) LCLSGeneral/POUs/Logger/SYSTEM_TIME_TO_RFC3339.TcPOU

    GVLs:
        1.) DefaultGlobals
        2.) GVL_Logger
codecov-io commented 4 years ago

Codecov Report

Merging #141 into master will increase coverage by 0.02%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #141      +/-   ##
==========================================
+ Coverage   77.71%   77.73%   +0.02%     
==========================================
  Files          16       16              
  Lines        1880     1882       +2     
==========================================
+ Hits         1461     1463       +2     
  Misses        419      419
Impacted Files Coverage Δ
pytmc/bin/summary.py 87.6% <100%> (+0.2%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 053fa26...3a8feb9. Read the comment docs.