-
Notifications
You must be signed in to change notification settings - Fork 0
/
TranskribusPyClient.py
1264 lines (1044 loc) · 54 KB
/
TranskribusPyClient.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
Transkribus REST API for Python clients
WORK IN PROGRESS...
Copyright Xerox(C) 2016, Naverlabs Europe 2019 H. Déjean, JL. Meunier
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Developed for the EU project READ. The READ project has received funding
from the European Union’s Horizon 2020 research and innovation programme
under grant agreement No 674943.
"""
from __future__ import absolute_import
from __future__ import print_function
from __future__ import unicode_literals
from builtins import str
from builtins import input
import sys
import os
import logging
import requests
from io import open
import json
import shutil
import pickle
# from TranskribusDU.common.trace import trace,flush
# import libxml2
from lxml import etree
# should be import etree.ElementTree as ET
utf8="utf-8"
def getStoredCredentials(bAsk=False):
login, pwd = None, None
try:
import Transkribus_credential
login, pwd = Transkribus_credential.login, Transkribus_credential.password
del Transkribus_credential
except ImportError:
logging.warn("No Transkribus credentials. Consider having a 'Transkribus_credential.py' Python module or use a persistent session using --persist.")
if bAsk:
# PY2 PY3
login, pwd = input("Enter your Transkribus login: "), input("Enter your Transkribus password: ")
if login == None or pwd == None:
raise ValueError("Missing Transkribus credentials!")
return login, pwd
class TranskribusClient():
"""
See web sites below for a detailed description of the server API:
- https://transkribus.eu/wiki/index.php/REST_Interface
- https://transkribus.eu/TrpServer/rest/application.wadl
- https://github.com/Transkribus
-- Query Parameters
Most parameters can be passed as string.
Transkribus specifies some of them as xs:int for instance.
In that case, you can pass an int or a string, since we format them using the pythoninc "%s".
-- Proxies
If you need to use a proxy, you can configure individual requests with the proxies argument to the login method:
myproxies = {
'http': 'http://10.10.1.10:3128',
'https': 'http://10.10.1.10:1080',
}
clientObj.auth_login("_login_", "_pwd_", proxies=myproxies)
You can also configure proxies by setting the environment variables HTTP_PROXY and HTTPS_PROXY.
$ export HTTP_PROXY="http://10.10.1.10:3128"
$ export HTTPS_PROXY="http://10.10.1.10:1080"
To use HTTP Basic Auth with your proxy, use the http://user:password@host/ syntax:
proxies = {'http': 'http://user:[email protected]:3128/'}
To give a proxy for a specific scheme and host, use the scheme://hostname form for the key. This will match for any request to the given scheme and exact hostname.
proxies = {'http://10.20.1.128': 'http://10.10.1.10:5323'}
Note that proxy URLs must include the scheme.
"""
#timestamp file extension
_POSTFIX_MAX_TX = "_max.ts"
#persistent session folder and filename
_sSESSION_FOLDER = ".trnskrbs"
_sSESSION_FILENAME = "session.txt"
#--- --- INIT --- -------------------------------------------------------------------------------------------------------------
def __init__(self, sServerUrl="https://transkribus.eu/TrpServer"
, proxies={}
, loggingLevel=logging.WARN):
self._sessionID = None # if logged in, id of the session, None otherwise
self._dProxies = {} # proxy settings
self.sServerUrl= sServerUrl
# Raise or lower this setting according to the amount of debugging
# output you would like to see. See http://docs.python.org/lib/module-logging.html
logging.basicConfig(level=loggingLevel)
self.setProxies(proxies)
#self._assertUrl(sServerRootUrl)
if sServerUrl.endswith("/"): sServerUrl = sServerUrl[:-1]
self.sREQ_auth_login = sServerUrl + '/rest/auth/login'
self.sREQ_auth_logout = sServerUrl + '/rest/auth/logout'
# self.sREQ_ReqListRNNModel = sServerUrl + '/rest/recognition/nets'
# self.sREQ_ReqListDict = sServerUrl + '/rest/recognition/dicts'
# self.sREQ_ReqRNN = sServerUrl + '/rest/recognition/rnn?' +'collId=%s&modelName=%s&dict=%s&id=%s&pages=%s'
#
#
self.sREQ_LA_batch = sServerUrl + '/rest/LA/batch'
self.sREQ_LA_analyze = sServerUrl + '/rest/LA/analyze'
self.sREQ_LA = sServerUrl + '/rest/LA'
# self.sREQ_LA = sServerUrl + '/rest/LA/analyzeLayout'
#
# self.sREQ_LALines = sServerUrl + '/rest/LA/lines'
# self.sREQ_LABaseLines = sServerUrl + '/rest/LA/baselines'
self.sREQ_collection = sServerUrl + '/rest/collections'
self.sREQ_collection_listEditDeclFeats = sServerUrl + '/rest/collections/%s/listEditDeclFeats'
self.sREQ_collection_list = sServerUrl + '/rest/collections/%s/list'
self.sREQ_collection_createCollection = sServerUrl + '/rest/collections/createCollection'
self.sREQ_collection_createDocument = sServerUrl + '/rest/collections/%s/upload'
self.sREQ_collection_deleteDocument = sServerUrl + '/rest/collections/%s/%s'
self.sREQ_collection_export = sServerUrl + '/rest/collections/%s/%s/export'
self.sREQ_collection_fulldoc = sServerUrl + '/rest/collections/%s/%s/fulldoc'
self.sREQ_collection_fulldoc_xml = sServerUrl + '/rest/collections/%s/%s/fulldoc.xml'
self.sREQ_collections_postPageTranscript = sServerUrl + '/rest/collections/%s/%s/%s/text'
self.sREQ_collections_deletePageTranscript = sServerUrl + '/rest/collections/%s/%s/%s/delete'
self.sREQ_collections_addDocToCollection = sServerUrl + '/rest/collections/%s/addDocToCollection'
self.sREQ_collections_duplicate = sServerUrl + '/rest/collections/%s/%s/duplicate'
self.sREQ_collections_listPagesLocks = sServerUrl + '/rest/collections/%s/%s/%s/listLocks'
self.sREQ_collections_updatePageStatus = sServerUrl + '/rest/collections/%s/%s/%s/%s'
self.sREQ_recognition = sServerUrl + '/rest/recognition'
self.sREQ_recognition_htrModels = sServerUrl + '/rest/recognition/htrModels'
self.sREQ_recognition_htr = sServerUrl + '/rest/recognition/htr'
self.sREQ_recognition_pylaia = sServerUrl + '/rest/pylaia/%s/%s/recognition'
self.sREQ_recognition_htrRnnModels = sServerUrl + '/rest/recognition/nets' #htrModels' #/rest/recognition/nets'
self.sREQ_recognition_htrRnnModels = sServerUrl + '/rest/recognition/htrModels'
self.sREQ_recognition_listHtr = sServerUrl + '/rest/recognition/%s/list'
self.sREQ_recognition_uploadDict = sServerUrl + '/rest/recognition/tempDict'
self.sREQ_recognition_htrRnnDicts = sServerUrl + '/rest/recognition/dicts'
self.sREQ_recognition_htrRnn = sServerUrl + '/rest/recognition/%s/%s/htrCITlab'
self.sREQ_recognition_htrTrainCITlab = sServerUrl + '/rest/recognition/htrTrainingCITlab'
self.sREQ_jobs = sServerUrl + '/rest/jobs/%s'
self.sREQ_jobskill = sServerUrl + '/rest/jobs/%s/kill'
self.sREQ_getJobs = sServerUrl + '/rest/jobs/list'
# self.sREQ_GetPAGEXML = sServerUrl + '/rest/collections/%s/%s/%s'
# self.sREQ_PostPAGEXML = sServerUrl + '/rest/collections/%s/%s/%s/text'
#--- --- auth --- -------------------------------------------------------------------------------------------------------------
def auth_login(self, sLogin, sPwd, bPersist=True):
"""
login to the server
If bPersistent is True, the session token is persisted on disk.
Further calls from another process can be made without login by using reusePersistentSession method
Return True or raise an exception
"""
if self._sessionID:
self._raiseError(Exception, "You are already logged in. Please logout before logging in.")
data = {'user': sLogin, 'pw': sPwd}
resp = self._POST(self.sREQ_auth_login, data = {'user': sLogin, 'pw': sPwd}, sContentType=None)
del data
resp.raise_for_status()
##extract sessionID from xml
lsSessionId = self._xmlParse__xpathEval_getContent(resp.text, "//sessionId/text()")
self.setSessionId(lsSessionId[0])
if bPersist: self.setPersistentSession()
return True
def auth_logout(self):
"""
Logout from the server, remove any persistent session token from disk
Return True or raise an exception
"""
try: self.cleanPersistentSession()
except: pass
try:
resp = self._POST(self.sREQ_auth_logout)
resp.raise_for_status()
finally:
self._sessionID = None
return True
#--- --- collections --- -------------------------------------------------------------------------------------------------------------
def listEditDeclFeatures(self, colId):
"""
Return the Transkribus data structure (XML as a DOM)
or raise an exception
Caller must free the DOM using the _xmlFreeDoc method of this object.
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_listEditDeclFeats % (colId)
resp = self._GET(myReq)
resp.raise_for_status()
#we get some json serialized data
return self._xmlParseDoc(resp.text)
def listDocsByCollectionId(self, colId, index=None, nValues=None, sortColumn=None, sortDirection=None):
"""
Return the Transkribus data structure (Pythonic data)
or raise an exception
Undocumented parameters, sorry.
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_list % (colId)
params = self._buidlParamsDic(index=None, nValues=None, sortColumn=None, sortDirection=None)
resp = self._GET(myReq, params=params, accept="application/json")
resp.raise_for_status()
#we get some json serialized data
return json.loads(resp.text)
def createCollection(self, sName):
"""
create a new collectin with given name.
Return the collection unique identifier: colId (as a string)
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_createCollection
resp = self._POST(myReq, params={'collName':sName }, sContentType='application/x-www-form-urlencoded')
resp.raise_for_status()
return resp.text
def deleteCollection(self, colId):
"""
delete a collection
Return True
"""
self._assertLoggedIn()
myReq = self.sREQ_collection+"/%s"%colId
resp = self._DELETE(myReq, { 'collId':colId })
resp.raise_for_status()
return resp.text
def createDocument(self,colId,zipFileStreamIO):
"""
upload a set of images in a folder
images must be zipped
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_createDocument % colId
resp = self._POST(myReq, data=zipFileStreamIO,sContentType='application/octet-stream')
resp.raise_for_status()
return resp.text
def deleteDocument(self, colId, docId):
"""
delete a document from a collection
Return True
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_deleteDocument%(colId, docId)
resp = self._DELETE(myReq, { 'collId':colId, 'id':docId })
resp.raise_for_status()
return resp
def getDocById(self, colId, docId, nrOfTranscripts=None):
"""
Return the Transkribus data structure ( Pythonic data )
or raise an exception
nrOfTranscripts can be either -1 (all), 0 (no transcripts) or any positive max. value of transcripts you want to receive per page.
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_fulldoc % (colId,docId)
params = self._buidlParamsDic(nrOfTranscripts=nrOfTranscripts)
resp = self._GET(myReq, params=params,accept="application/json")
resp.raise_for_status()
#we get some json serialized data
return json.loads(resp.text)
def getDocByIdAsXml(self, colId, docId, nrOfTranscripts=None, bParse=True):
"""
Return the Transkribus data structure (either parsed as a DOM or as a serialized XML, , i.e. a unicode string)
or raise an exception
If you get a DOM, you need to free it afterward using the _xmlFreeDoc method.
nrOfTranscripts can be either -1 (all), 0 (no transcripts) or any positive max. value of transcripts you want to receive per page.
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_fulldoc_xml % (colId,docId)
params = self._buidlParamsDic(nrOfTranscripts=nrOfTranscripts)
resp = self._GET(myReq, params=params)
resp.raise_for_status()
#we should get some json serialized data
if bParse:
return self._xmlParseDoc(resp.text)
else:
return resp.text
def exportCollection(self,colId,docId,sparams):
"""
export document
"""
self._assertLoggedIn()
myReq = self.sREQ_collection_export % (colId,docId)
sjson=json.loads(sparams)
resp = self._POST(myReq, json=sjson,sContentType = "application/json")
resp.raise_for_status()
return resp.text
# def postPageTranscript(self, colId, docId, pnum, sStatus, sXMlTranscript
# the status parameter when saving a transcript is becoming obsolete anyway (updating the status should be done with a separate call in the future: updatePageStatus).
# You should be fine by setting it to null, i.e. completely omitting this parameter. If you want to use it, then try NEW, IN_PROGRESS, DONE, FINAL as values (cf.
# https://github.com/Transkribus/TranskribusCore/blob/master/src/main/java/eu/transkribus/core/model/beans/enums/EditStatus.java)
def postPageTranscript(self, colId, docId, pnum, sXMlTranscript
, bOverwrite=None
, sNote=None
, parentId=None
, bPnumIsPageId=None
, sToolName=None
, status = None
, bEncoded=False): #bEncoded is not part of official API, it is a convenience for Pythonic API
"""
Post a new transcript for a page
sXmlTranscript is a Python Unicode string
return a serialized XMl like:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><trpTranscriptMetadata><tsId>424778</tsId><parentTsId>-1</parentTsId><key>IXQDKIMHCKSJAAVUZLWMIKRV</key><pageId>252384</pageId><docId>8255</docId><pageNr>1</pageNr><url>https://dbis-thure.uibk.ac.at/f/Get?id=IXQDKIMHCKSJAAVUZLWMIKRV</url><status>IN_PROGRESS</status><userName>[email protected]</userName><userId>3556</userId><timestamp>1481281786096</timestamp><md5Sum></md5Sum><nrOfRegions>4</nrOfRegions><nrOfTranscribedRegions>3</nrOfTranscribedRegions><nrOfWordsInRegions>131</nrOfWordsInRegions><nrOfLines>41</nrOfLines><nrOfTranscribedLines>40</nrOfTranscribedLines><nrOfWordsInLines>168</nrOfWordsInLines><nrOfWords>0</nrOfWords><nrOfTranscribedWords>0</nrOfTranscribedWords></trpTranscriptMetadata>
<trpTranscriptMetadata>
<tsId>424778</tsId>
<parentTsId>-1</parentTsId>
<key>IXQDKIMHCKSJAAVUZLWMIKRV</key>
<pageId>252384</pageId>
<docId>8255</docId>
<pageNr>1</pageNr>
<url>https://dbis-thure.uibk.ac.at/f/Get?id=IXQDKIMHCKSJAAVUZLWMIKRV</url>
<status>IN_PROGRESS</status>
<userName>[email protected]</userName>
<userId>3556</userId>
<timestamp>1481281786096</timestamp>
<md5Sum/>
<nrOfRegions>4</nrOfRegions>
<nrOfTranscribedRegions>3</nrOfTranscribedRegions>
<nrOfWordsInRegions>131</nrOfWordsInRegions>
<nrOfLines>41</nrOfLines>
<nrOfTranscribedLines>40</nrOfTranscribedLines>
<nrOfWordsInLines>168</nrOfWordsInLines>
<nrOfWords>0</nrOfWords>
<nrOfTranscribedWords>0</nrOfTranscribedWords>
</trpTranscriptMetadata>
"""
self._assertLoggedIn()
if not bEncoded: self._assertUnicode(sXMlTranscript)
myReq = self.sREQ_collections_postPageTranscript % (colId,docId,pnum)
params = self._buidlParamsDic(overwrite=bOverwrite, note=sNote, parent=parentId, nrIsPageId=bPnumIsPageId,toolName=sToolName, status=status)
if bEncoded:
resp = self._POST(myReq, params=params, data=sXMlTranscript)
else:
resp = self._POST(myReq, params=params, data=sXMlTranscript.encode(utf8))
resp.raise_for_status()
return resp.text
def deletePageTranscript(self, colId, docId, pnum, sTranscriptKey):
"""
Delete a transcript
"""
self._assertLoggedIn()
myReq = self.sREQ_collections_deletePageTranscript % (colId,docId,pnum)
params = self._buidlParamsDic(key=sTranscriptKey)
resp = self._POST(myReq, params=params)
resp.raise_for_status()
return resp.text
def updatePageStatus(self, colId, docId, pnum, sTranscriptId, sStatus, sNote):
"""
Update the status of a transcript
September 2017
I just looked it up in the code and this is the intended behavior:
a status update should only work for the most recent transcript!
if the given tsId does not belong to the current transcript, then you
should get a BAD REQUEST response.
(I could omit the tsId in the path but then there might be another user
saving in that time and the status would be updated unintentionally on
the new version. Don't know if that is a good idea...)
For an already stored transcript, it is only possible to update the
status on this entity if your user account was used to save it.
If the respective transcript was saved by another user, then a duplicate
will be stored under your name with a _new timestamp_. This is done
silently at the moment. I could return a non-200 status code in that
case if it helps.
So if there is a mess after using this function, please let me know. I'd
like to fix it immediately.
Best regards,
Philip
"""
self._assertLoggedIn()
myReq = self.sREQ_collections_updatePageStatus % (colId,docId,pnum,sTranscriptId)
params = self._buidlParamsDic(status=sStatus, note=sNote)
resp = self._POST(myReq, params=params)
resp.raise_for_status()
return True
def addDocToCollection(self, colId, docId):
"""
Add document docId to collection colId (this is not a copy!!)
Return True or raises an Exception
NOTE the REST API does not return the new DocId... :-/
"""
self._assertLoggedIn()
#myReq = self.sREQ_collections_addDocToCollection % (colId) + "?id=%s"%docId
myReq = self.sREQ_collections_addDocToCollection % (colId)
resp = self._POST(myReq, {'id':docId} , sContentType="*/*")
resp.raise_for_status()
# return resp.text #return "" or something like " document is already in collection"
#maise raise an exception upon server error
# requests.exceptions.HTTPError: 500 Server Error: Internal Server Error for url: https://transkribus.eu/TrpServer/rest/collections/3820/addDocToCollection?id=66666
return True
def duplicateDoc(self, colIdFrom, docId, colIdTo, name=None):
"""
Copy document docId from collection colIdFrom to collection colIdTo
The document is renamed if a name is provided
Return True or raises an Exception
"""
self._assertLoggedIn()
#myReq = self.sREQ_collections_addDocToCollection % (colId) + "?id=%s"%docId
myReq = self.sREQ_collections_duplicate % (colIdFrom, docId)
if not name:
name = -1
#let's find it! :-(
lDocDic = self.listDocsByCollectionId(colIdFrom)
for docDic in lDocDic:
if docDic['docId'] == docId:
name = docDic['title']
break
if name == -1: raise Exception("Document '%d' is not in source collection '%d'"%(docId, colIdFrom))
self._assertString(name, "name")
resp = self._POST(myReq, {'name':name.encode(utf8), 'collId':colIdTo} )
"""
NO WAY TO GET THE CREATED ID???
print resp.headers
print resp.text
> TranskribusCommands/do_copyDocToCollec.py 3571 3820 8251 --persist
-login- Try reusing persistent session ... OK!
- checking names of each document in source collection '3571'
- copying from collection 3571 to collection '3820' the 1 documents: 8251 ('MM_1_012'){'Content-Length': '5', 'Keep-Alive': 'timeout=5, max=100', 'Server': 'Apache/2.4.6 (CentOS) OpenSSL/1.0.1e-fips PHP/5.4.16 mod_wsgi/3.4 Python/2.7.5', 'Connection': 'Keep-Alive', 'Access-Control-Allow-Credentials': 'true', 'Date': 'Mon, 28 Nov 2016 14:52:53 GMT', 'Access-Control-Allow-Origin': 'http://www.transcribe-bentham.da.ulcc.ac.uk', 'Access-Control-Allow-Headers': 'Content-Type', 'Content-Type': 'text/plain;charset=utf-8', 'P3P': 'CP="ALL IND DSP COR ADM CONo CUR CUSo IVAo IVDo PSA PSD TAI TELo OUR SAMo CNT COM INT NAV ONL PHY PRE PUR UNI"'}
31033
"""
resp.raise_for_status()
# return resp.text #return "" or something like " document is already in collection"
#maise raise an exception upon server error
# requests.exceptions.HTTPError: 500 Server Error: Internal Server Error for url: https://transkribus.eu/TrpServer/rest/collections/3820/addDocToCollection?id=66666
return True
def download_collection(self, colId, collDir, bForce=False, bNoImage=False,sDocId=None):
"""
Convenience method, not provided directly by the Transkribus API.
Lazy download of the colId collection into the collDir folder.
Lazy, because it does not download a document that is not more recent than the one one disk. It uses page timestamp to decide.
Both the XML and images are fetched from the server.
The destination folder is created if required.
It also creates 1 sub-folder per document in the collection.
If the folder exists, raise an exception, unless bForce is True in which case, the folder is removed and recreated.
Return the maximum timestamp over all pages of the collection.
"""
logging.info("- downloading collection %s into folder %s (bForce=%s)"%(colId, collDir, bForce))
if not os.path.exists(collDir): os.mkdir(collDir)
coll_max_ts = -1
#list collection content
lDocInfo = self.listDocsByCollectionId(colId)
# store collections metadata
if sys.version_info > (3,0):
with open(collDir+os.sep+"trp.json", "wt",encoding='utf-8') as fd: json.dump(lDocInfo, fd, indent=2)
else:
with open(collDir+os.sep+"trp.json", "wb",) as fd: json.dump(lDocInfo, fd, indent=2)
ldocID = []
dLFileList= {}
for docInfo in lDocInfo:
bSkip=False
docId = docInfo['docId'] #int here!!!
if sDocId is not None:
if str(docId) != str(sDocId):
bSkip=True
if not bSkip:
ldocID.append(str(docId))
docDir = os.path.join(collDir, str(docId))
#Maybe we already have this version of the document??
stored_doc_ts_file = docDir+self._POSTFIX_MAX_TX
if os.path.exists(stored_doc_ts_file):
with open(stored_doc_ts_file, 'r',encoding='utf-8') as fd: stored_doc_ts = fd.read()
stored_doc_ts = int(stored_doc_ts)
else:
stored_doc_ts = -1
doc_max_ts, lfileList = self.download_document(colId, docId, docDir, min_ts=stored_doc_ts, bForce=bForce, bOverwrite=False, bNoImage=bNoImage)
dLFileList[str(docId)]=lfileList
assert doc_max_ts >= stored_doc_ts, "Server side data older than disk data???"
if doc_max_ts == stored_doc_ts:
#NOTE: we did not check each page!!
logging.info("\tcollection %s, document %s, data on disk is UP-TO-DATE - I do nothing else."%(colId, docId))
else:
with open(stored_doc_ts_file, "w",encoding='utf-8') as fd: fd.write("%s"%doc_max_ts)
coll_max_ts = max(coll_max_ts, doc_max_ts)
logging.info("- DONE (downloaded doc %s)"%(docId))
if sDocId is not None and not ldocID: raise ValueError("No such document")
logging.info("- DONE (downloaded collection %s into folder %s (bForce=%s))"%(colId, collDir, bForce))
return coll_max_ts, ldocID, dLFileList
def download_document(self, colId, docId, docDir, min_ts=-1, bForce=False, bOverwrite=False, bNoImage=False, trp_spec=None):
"""
Convenience method, not provided directly by the Transkribus API.
Lazy download of the colId, docId document into the docDir folder.
Lazy, because it does not download a document that is not more recent than the given timestamp. It uses page timestamp to decide.
Both the XML and images are fetched from the server.
If the destination folder exists:
- if bForce is True, the folder is removed and recreated.
- if bOverwrite is True, overwrite whatever is conflicting
- otehrwise raise an Exception
Return the maximum timestamp over all pages of the document.
"""
if trp_spec:
logging.info("- downloading collection %s, document %s into folder %s (bForce=%s) as specified by trp"%(colId, docId, docDir, bForce))
#sanity check
if str(trp_spec["collection"]["colId"]) != str(colId):
raise ValueError("Collection ID does not match colId of TRP data.")
if docId:
if str(trp_spec["md"]["docId"]) != str(docId):
raise ValueError("Document ID does not match docId of TRP data.")
else:
docId = trp_spec["md"]["docId"]
trp = trp_spec
else:
logging.info("- downloading collection %s, document %s into folder %s (bForce=%s)"%(colId, docId, docDir, bForce))
trp = self.getDocById(colId, docId, nrOfTranscripts=1)
pageList = trp["pageList"]
doc_max_ts = max( [page['tsList']["transcripts"][0]['timestamp'] for page in pageList['pages'] ] )
if doc_max_ts <= min_ts:
#no need to download
#NOTE: we do not check each page!!
return doc_max_ts, None
#Ok, we must refresh the disk
if os.path.exists(docDir):
#we need to deal with this existing folder.
if bOverwrite:
logging.warn("existing data, we may overwrite some data in %s"%docDir)
elif bForce:
logging.warn("\t\t REMOVING OBSOLETE DATA in %s... "%docDir)
shutil.rmtree(docDir)
os.mkdir(docDir)
logging.warn("\t\tDone removal.")
else:
logging.warn("\t\t**** EXISTING DATA ON DISK in %s - I do nothing unless you force the overwriting"%docDir)
raise Exception("Existing data on disk, cannot download collection %s, document %s into folder %s, unless bForce=True"%(colId, docId, docDir))
else:
os.mkdir(docDir)
if not trp_spec:
# store document metadata, if not provided
if sys.version_info > (3,0):
with open(docDir+os.sep+"trp.json", "wt",encoding='utf-8') as fd: json.dump(trp, fd, sort_keys=True, indent=2, separators=(',', ': '))
else:
with open(docDir+os.sep+"trp.json", "wb") as fd: json.dump(trp, fd, sort_keys=True, indent=2, separators=(',', ': '))
lFileList= []
for page in pageList['pages']:
pagenum= page['pageNr']
logging.info("\t\t- page %s"%pagenum)
imgFileName = page['imgFileName']
base,_= os.path.splitext(imgFileName)
lFileList.append(base)
urlImage= page['url']
dicTranscript0 = page['tsList']["transcripts"][0]
urlXml = dicTranscript0['url']
#Now store the image and pageXml
if not bNoImage:
destImgFilename = docDir + os.sep + imgFileName
logging.info("\t\t\t%s"%destImgFilename)
resp = self._GET(urlImage, stream=True)
with open(destImgFilename, 'wb') as fd:
for chunk in resp.iter_content(10240):
fd.write(chunk)
sBaseName, _ = os.path.splitext(imgFileName)
destXmlFilename = docDir + os.sep + sBaseName + ".pxml"
logging.info("\t\t\t%s"%destXmlFilename)
resp = self._GET(urlXml)
savefile=open(destXmlFilename,'wt',encoding='utf-8')
savefile.write(resp.text)
savefile.close()
print('.',end=''); sys.stdout.flush()
# flush()
with open(docDir+os.sep+"max.ts", "w") as fd: fd.write("%s"%doc_max_ts)
logging.info("- DONE (downloaded collection %s, document %s into folder %s (bForce=%s))"%(colId, docId, docDir, bForce))
return doc_max_ts, lFileList
def getListofLockedPages(self, colid, docid, page):
"""
return the list of locks for colid/docid/page
"""
self._assertLoggedIn()
myReq = self.sREQ_collections_listPagesLocks% (colid,docid,page)
resp = self._GET(myReq, accept="application/json")
resp.raise_for_status()
#return resp.text
return json.loads(resp.text)
# -------LAYOUT ANALYSIS ------------------------------------------------------------------------------------------
def tableMatching(self,templateID,colId, sDescription,params,sJobImpl="CvlTableJob"):
"""
apply a template to a transcript
templateID= transcript ID
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobParameters>
<docList>
<docs>
<docId>1</docId>
<pageList>
<pages>
<pageId>2</pageId>
<tsId>3</tsId>
</pages>
</pageList>
</docs>
</docList>
<params>
<entry>
<key>templateId</key>
<value>1543</value>
</entry>
</params>
</jobParameters>
"""
self._assertLoggedIn()
myReq = self.sREQ_LA #self.sREQ_LA_analyze
params = self._buidlParamsDic(collId=colId
, jobImpl=sJobImpl)
# print (myReq, params, sDescription)
resp = self._POST(myReq, params=params, data=sDescription,sContentType="application/xml")
resp.raise_for_status()
return resp.text
def analyzeLayoutNew(self, colId, sDescription, sJobImpl="CITlabAdvancedLaJob"
, sPars=""
, bBlockSeg = False
, bLineSeg = True
, bWordSeg = False
, bPolygonToBaseline = False
, bBaselineToPolygon = False
, bCreateJobBatch = False):
"""
Hi Hervé,
Sebastian has done the integration of the tools and can answer more indepth questions.
Please take a look at:
https://transkribus.eu/TrpServer/Swadl/wadl.html
or
https://transkribus.eu/TrpServer/rest/application.wadl
The new methods are at:
/LA/analyze
Valid values for the jobImpl parameter are:
NcsrLaJob
CvlLaJob
You have to post a list of descriptor objects either as XML or JSON to the service, specifying the pages that have to be analyzed. A single page descriptor would look like this (regionId optional):
<documentSelectionDescriptor>
<docId>1</docId>
<pageList>
<pages>
<pageId>2</pageId>
<tsId>3</tsId>
<regionIds>aRegionId</regionIds>
</pages>
</pageList>
</documentSelectionDescriptor>
Do let us know if there are any problems with the new method.
Best regards and have a nice weekend,
Philip
"""
self._assertLoggedIn()
myReq = self.sREQ_LA_analyze
# params = self._buidlParamsDic(collId=colId
# , doBlockSeg=bBlockSeg, doLineSeg=bLineSeg, doWordSeg=bWordSeg
# , doPolygonToBaseline=bPolygonToBaseline, doBaselineToPolygon=bBaselineToPolygon
# , jobImpl=sJobImpl,pars=sPars)
#https://transkribus.eu/TrpServerTesting/rest/LA/analyze?doLineSeg=true&collId=2&doBlockSeg=true&doWordSeg=false&jobImpl=CITlabAdvancedLaJob
params = self._buidlParamsDic(collId=colId
, doBlockSeg=bBlockSeg, doLineSeg=bLineSeg, doWordSeg=bWordSeg
# , doPolygonToBaseline=False, doBaselineToPolygon=False
, doCreateJobBatch=bCreateJobBatch
, jobImpl=sJobImpl)
# print (myReq, params, sDescription)
resp = self._POST(myReq, params=params, data=sDescription,sContentType="application/xml")
# print resp.text
resp.raise_for_status()
return resp.text
def analyzeLayoutBatch(self,colId, docId, sPages, bBlockSeg, bLineSeg):
"""
apply Layout Analysis
int colId,
int docId,
String pages, (1 or 1,5 or 1-5, or 1,3,5-8 etc)
boolean doBlockSeg (True by default),
boolean doLineSeg (True by default)
return a jobId
"""
self._assertLoggedIn()
myReq = self.sREQ_LA_batch
params = self._buidlParamsDic(collId=colId, id=docId, pages=sPages, doBlockSeg=bBlockSeg, doLineSeq=bLineSeg)
resp = self._POST(myReq, params=params, sContentType=None)
resp.raise_for_status()
return resp.text
# --------RECOGNITION-----------------------------------------------------------------------------------
## training
def htrTrainingCITlab(self,XMLconf):
"""
train an HTR with information stored in XMLconf
"""
self._assertLoggedIn()
myReq = self.sREQ_recognition_htrTrainCITlab
resp = self._POST(myReq, data = XMLconf)
resp.raise_for_status()
return resp.text
def listHmmHtrModels(self):
"""
List the HTR models
Return a list of dictionaries, like:
[
{
"modelName": "Marine_Lives",
"nrOfTokens": 0,
"isUsableInTranskribus": 1,
"nrOfDictTokens": 0,
"nrOfLines": 0,
"modelId": 45
},
...
or raise an exception
"""
self._assertLoggedIn()
myReq = self.sREQ_recognition_htrModels
resp = self._GET(myReq, accept="application/json")
resp.raise_for_status()
#we get some json serialized data
return json.loads(resp.text)
def htrDecode(self, colId, sHtrModelName, docId, sPages):
"""
Do the HTR using the given model.
- Maybe you can set sPages to None, or both docId and sPage to None ??
Return the Transkribus server response (a job id)
or raise an exception
"""
self._assertLoggedIn()
myReq = self.sREQ_recognition_htr
params = self._buidlParamsDic(collId=colId, modelName=sHtrModelName, id=docId, pages=sPages)
resp = self._POST(myReq, params=params)
resp.raise_for_status()
return resp.text
# ---
def listRnns(self,colid):
"""
"""
self._assertLoggedIn()
myReq = self.sREQ_recognition_listHtr % (colid)
#params = self._buidlParamsDic(prov='CITlab')
params={}
resp = self._GET(myReq, params=params, accept="application/json")
resp.raise_for_status()
return json.loads(resp.text)
def listRnnsText(self):
"""
List the HTR RNN models
Return a textual list of dictionary names, one per line
or raise an exception
"""
self._assertLoggedIn()
myReq = self.sREQ_recognition_htrRnnModels
resp = self._GET(myReq, accept="text/plain")
resp.raise_for_status()
return resp.text
def listDictsText(self):
"""
List the HTR RNN dictionaries
Return a textual list of dictionary names, one per line
or raise an exception
Undocumented parameters, sorry.
"""
self._assertLoggedIn()
myReq = self.sREQ_recognition_htrRnnDicts
resp = self._GET(myReq, accept="text/plain")
resp.raise_for_status()
return resp.text
def uploadDict(self,dictName,dictString):
"""
temp. dictionaries also can be sent now, see example below.
The response will contain the dict. filename to be used in the HTR
request's tempDict parameter. If extension of the given name does not
match ".dict", this will be appended.
The POST request's body should contain the dictionary data as UTF-8 String.
The temp. dictionaries are now bound to the user account and you can
check the transmission outcome by logging in via FTP to transkribus.eu
with your credentials. There you will find a dir. called "dictTmp"
containing the sent files, that will be used for HTR. You can also put
dictionaries there via FTP and use them for HTR with the tempDict parameter.
POST /TrpServerTesting/rest/recognition/tempDict?fileName=test.dict HTTP/1.1
Host: transkribus.eu
Content-Type: text/plain
Cache-Control: no-cache
wanŋ,16
"""
#sREQ_recognition_uploadDict
self._assertLoggedIn()
myReq = self.sREQ_recognition_uploadDict
params = self._buidlParamsDic(fileName=dictName)
resp = self._POST(myReq, params = params,data = dictString.encode('utf-8'),sContentType="text/plain")
resp.raise_for_status()
return resp.text
def htrRnnDecode(self, colId, sRnnModelID, docId, sPagesDesc, bPyLaia= True,bDictTemp=False):
"""
Do the HTR using the given RNN model and dictionary.
- Maybe you can set sPages to None, or both docId and sPage to None ??
Return the Transkribus server response (a job id)
or raise an exception
it should do a full page HTR if either
- the regionIds set is empty (I assume this works only when using JSON)
- the regionIds element is missing from the XML/JSON
Internally, I use the regionIds and gather all respective lineIds, which
is what the HTR and Baseline2Polygon interfaces expect as argument.
So if you use that (and it works correctly on my end) then you should
have the typical "jagged" polygons, produced by URO Baseline2Polygon, on
the processed lines in the new PAGE XML.
"""
self._assertLoggedIn()
if bPyLaia:
myReq = self.sREQ_recognition_pylaia % (colId,str(sRnnModelID))
else:
myReq = self.sREQ_recognition_htrRnn % (colId,sRnnModelID)
#if bDictTemp:
# params = self._buidlParamsDic(id=docId,tempDict=sDictName)
#elif sDictName != "None":
# params = self._buidlParamsDic(id=docId,dict=sDictName, doLinePolygonSimplification=False,keepOriginalLinePolygons=True)
#else:
params = self._buidlParamsDic(id=docId,doLinePolygonSimplification=False,keepOriginalLinePolygons=True)
postparams= sPagesDesc #'{"docId":17442,"pageList":{"pages":[{"pageId":400008,"tsId":1243590,"regionIds":[]}]}}'
# postparams= '{"docId":17442,"pageList":{"pages":[{"pageId":400008,"tsId":1243590,"regionIds":[]}]}}'
resp = self._POST(myReq, params=params,data=postparams , sContentType = "application/json")
resp.raise_for_status()
return resp.text
# --- JOB -----------------------------------------------------------------------------------------
def getJobIDsFromXMLStatuses(self,xmlString):
"""
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<trpJobStatuses>
<trpJobStatus>
<jobId>193504</jobId>
<docId>29436</docId><pageNr>1</pageNr><type>Layout analysis (CITlabAdvancedLaJob: lines)</type><state>CREATED</state><success>false</success><description></description><userName>[email protected]</userName><userId>275</userId><createTime>1511864236714</createTime><startTime>0</startTime><endTime>0</endTime><jobData>#Tue Nov 28 11:17:16 CET 2017
doWordSeg=false
doLineSeg=true
doPolygonToBaseline=false
doBaselineToPolygon=false
doBlockSeg=false
</jobData><resumable>false</resumable><jobImpl>CITlabAdvancedLaJob</jobImpl><created>2017-11-28T11:17:16.714+01:00</created><pageid>971875</pageid><tsid>1594101</tsid><regionids></regionids><colId>8828</colId></trpJobStatus></trpJobStatuses>
"""
docroot = self._xmlParseDoc(xmlString)
lN= docroot.xpath("*//jobId")
if lN != []:
# return list(map(lambda x:x.text().decode('utf-8'),lN))
return list(map(lambda x:x.text,lN))
else:
return []
def getJobStatus(self, jobid):
"""
return the job status (a dictionary)
keys are the strings:
jobId, docId, pageNr, pages, type, state, success, description, userName, userId, createTime, startTime, endTime, jobData, resumable, jobImpl
state values: "CREATED", "RUNNING", "FINISHED", "FAILED"
"""